1 //! [Flexible target specification.](https://github.com/rust-lang/rfcs/pull/131)
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.
9 //! # Using custom targets
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
22 //! Projects defining their own targets should use
23 //! `--target=path/to/my-awesome-platform.json` instead of adding to
24 //! `RUST_TARGET_PATH`.
26 //! # Defining a new target
28 //! Targets are defined using [JSON](https://json.org/). The `Target` struct in
29 //! this module defines the format the JSON file should take, though each
30 //! underscore in the field names should be replaced with a hyphen (`-`) in the
31 //! JSON file. Some fields are required in every target specification, such as
32 //! `llvm-target`, `target-endian`, `target-pointer-width`, `data-layout`,
33 //! `arch`, and `os`. In general, options passed to rustc with `-C` override
34 //! the target's settings, though `target-feature` and `link-args` will *add*
35 //! to the list specified by the target, rather than replace.
37 use crate::abi::Endian;
38 use crate::spec::abi::{lookup as lookup_abi, Abi};
39 use crate::spec::crt_objects::{CrtObjects, CrtObjectsFallback};
40 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
41 use rustc_serialize::json::{Json, ToJson};
42 use rustc_span::symbol::{sym, Symbol};
43 use std::collections::BTreeMap;
44 use std::convert::TryFrom;
45 use std::ops::{Deref, DerefMut};
46 use std::path::{Path, PathBuf};
47 use std::str::FromStr;
50 use rustc_macros::HashStable_Generic;
65 mod hermit_kernel_base;
70 mod linux_kernel_base;
72 mod linux_uclibc_base;
84 mod windows_msvc_base;
85 mod windows_uwp_gnu_base;
86 mod windows_uwp_msvc_base;
88 #[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
89 pub enum LinkerFlavor {
99 #[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
108 fn from_str(s: &str) -> Option<Self> {
110 "darwin" => LldFlavor::Ld64,
111 "gnu" => LldFlavor::Ld,
112 "link" => LldFlavor::Link,
113 "wasm" => LldFlavor::Wasm,
119 impl ToJson for LldFlavor {
120 fn to_json(&self) -> Json {
122 LldFlavor::Ld64 => "darwin",
123 LldFlavor::Ld => "gnu",
124 LldFlavor::Link => "link",
125 LldFlavor::Wasm => "wasm",
131 impl ToJson for LinkerFlavor {
132 fn to_json(&self) -> Json {
133 self.desc().to_json()
136 macro_rules! flavor_mappings {
137 ($((($($flavor:tt)*), $string:expr),)*) => (
139 pub const fn one_of() -> &'static str {
140 concat!("one of: ", $($string, " ",)*)
143 pub fn from_str(s: &str) -> Option<Self> {
145 $($string => $($flavor)*,)*
150 pub fn desc(&self) -> &str {
152 $($($flavor)* => $string,)*
160 ((LinkerFlavor::Em), "em"),
161 ((LinkerFlavor::Gcc), "gcc"),
162 ((LinkerFlavor::Ld), "ld"),
163 ((LinkerFlavor::Msvc), "msvc"),
164 ((LinkerFlavor::PtxLinker), "ptx-linker"),
165 ((LinkerFlavor::BpfLinker), "bpf-linker"),
166 ((LinkerFlavor::Lld(LldFlavor::Wasm)), "wasm-ld"),
167 ((LinkerFlavor::Lld(LldFlavor::Ld64)), "ld64.lld"),
168 ((LinkerFlavor::Lld(LldFlavor::Ld)), "ld.lld"),
169 ((LinkerFlavor::Lld(LldFlavor::Link)), "lld-link"),
172 #[derive(Clone, Copy, Debug, PartialEq, Hash, Encodable, Decodable, HashStable_Generic)]
173 pub enum PanicStrategy {
179 pub fn desc(&self) -> &str {
181 PanicStrategy::Unwind => "unwind",
182 PanicStrategy::Abort => "abort",
186 pub fn desc_symbol(&self) -> Symbol {
188 PanicStrategy::Unwind => sym::unwind,
189 PanicStrategy::Abort => sym::abort,
194 impl ToJson for PanicStrategy {
195 fn to_json(&self) -> Json {
197 PanicStrategy::Abort => "abort".to_json(),
198 PanicStrategy::Unwind => "unwind".to_json(),
203 #[derive(Clone, Copy, Debug, PartialEq, Hash, Encodable, Decodable)]
204 pub enum RelroLevel {
212 pub fn desc(&self) -> &str {
214 RelroLevel::Full => "full",
215 RelroLevel::Partial => "partial",
216 RelroLevel::Off => "off",
217 RelroLevel::None => "none",
222 impl FromStr for RelroLevel {
225 fn from_str(s: &str) -> Result<RelroLevel, ()> {
227 "full" => Ok(RelroLevel::Full),
228 "partial" => Ok(RelroLevel::Partial),
229 "off" => Ok(RelroLevel::Off),
230 "none" => Ok(RelroLevel::None),
236 impl ToJson for RelroLevel {
237 fn to_json(&self) -> Json {
239 RelroLevel::Full => "full".to_json(),
240 RelroLevel::Partial => "partial".to_json(),
241 RelroLevel::Off => "off".to_json(),
242 RelroLevel::None => "None".to_json(),
247 #[derive(Clone, Copy, Debug, PartialEq, Hash, Encodable, Decodable)]
248 pub enum MergeFunctions {
254 impl MergeFunctions {
255 pub fn desc(&self) -> &str {
257 MergeFunctions::Disabled => "disabled",
258 MergeFunctions::Trampolines => "trampolines",
259 MergeFunctions::Aliases => "aliases",
264 impl FromStr for MergeFunctions {
267 fn from_str(s: &str) -> Result<MergeFunctions, ()> {
269 "disabled" => Ok(MergeFunctions::Disabled),
270 "trampolines" => Ok(MergeFunctions::Trampolines),
271 "aliases" => Ok(MergeFunctions::Aliases),
277 impl ToJson for MergeFunctions {
278 fn to_json(&self) -> Json {
280 MergeFunctions::Disabled => "disabled".to_json(),
281 MergeFunctions::Trampolines => "trampolines".to_json(),
282 MergeFunctions::Aliases => "aliases".to_json(),
287 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
288 pub enum RelocModel {
298 impl FromStr for RelocModel {
301 fn from_str(s: &str) -> Result<RelocModel, ()> {
303 "static" => RelocModel::Static,
304 "pic" => RelocModel::Pic,
305 "pie" => RelocModel::Pie,
306 "dynamic-no-pic" => RelocModel::DynamicNoPic,
307 "ropi" => RelocModel::Ropi,
308 "rwpi" => RelocModel::Rwpi,
309 "ropi-rwpi" => RelocModel::RopiRwpi,
315 impl ToJson for RelocModel {
316 fn to_json(&self) -> Json {
318 RelocModel::Static => "static",
319 RelocModel::Pic => "pic",
320 RelocModel::Pie => "pie",
321 RelocModel::DynamicNoPic => "dynamic-no-pic",
322 RelocModel::Ropi => "ropi",
323 RelocModel::Rwpi => "rwpi",
324 RelocModel::RopiRwpi => "ropi-rwpi",
330 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
339 impl FromStr for CodeModel {
342 fn from_str(s: &str) -> Result<CodeModel, ()> {
344 "tiny" => CodeModel::Tiny,
345 "small" => CodeModel::Small,
346 "kernel" => CodeModel::Kernel,
347 "medium" => CodeModel::Medium,
348 "large" => CodeModel::Large,
354 impl ToJson for CodeModel {
355 fn to_json(&self) -> Json {
357 CodeModel::Tiny => "tiny",
358 CodeModel::Small => "small",
359 CodeModel::Kernel => "kernel",
360 CodeModel::Medium => "medium",
361 CodeModel::Large => "large",
367 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
375 impl FromStr for TlsModel {
378 fn from_str(s: &str) -> Result<TlsModel, ()> {
380 // Note the difference "general" vs "global" difference. The model name is "general",
381 // but the user-facing option name is "global" for consistency with other compilers.
382 "global-dynamic" => TlsModel::GeneralDynamic,
383 "local-dynamic" => TlsModel::LocalDynamic,
384 "initial-exec" => TlsModel::InitialExec,
385 "local-exec" => TlsModel::LocalExec,
391 impl ToJson for TlsModel {
392 fn to_json(&self) -> Json {
394 TlsModel::GeneralDynamic => "global-dynamic",
395 TlsModel::LocalDynamic => "local-dynamic",
396 TlsModel::InitialExec => "initial-exec",
397 TlsModel::LocalExec => "local-exec",
403 /// Everything is flattened to a single enum to make the json encoding/decoding less annoying.
404 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug)]
405 pub enum LinkOutputKind {
406 /// Dynamically linked non position-independent executable.
408 /// Dynamically linked position-independent executable.
410 /// Statically linked non position-independent executable.
412 /// Statically linked position-independent executable.
414 /// Regular dynamic library ("dynamically linked").
416 /// Dynamic library with bundled libc ("statically linked").
418 /// WASI module with a lifetime past the _initialize entry point
422 impl LinkOutputKind {
423 fn as_str(&self) -> &'static str {
425 LinkOutputKind::DynamicNoPicExe => "dynamic-nopic-exe",
426 LinkOutputKind::DynamicPicExe => "dynamic-pic-exe",
427 LinkOutputKind::StaticNoPicExe => "static-nopic-exe",
428 LinkOutputKind::StaticPicExe => "static-pic-exe",
429 LinkOutputKind::DynamicDylib => "dynamic-dylib",
430 LinkOutputKind::StaticDylib => "static-dylib",
431 LinkOutputKind::WasiReactorExe => "wasi-reactor-exe",
435 pub(super) fn from_str(s: &str) -> Option<LinkOutputKind> {
437 "dynamic-nopic-exe" => LinkOutputKind::DynamicNoPicExe,
438 "dynamic-pic-exe" => LinkOutputKind::DynamicPicExe,
439 "static-nopic-exe" => LinkOutputKind::StaticNoPicExe,
440 "static-pic-exe" => LinkOutputKind::StaticPicExe,
441 "dynamic-dylib" => LinkOutputKind::DynamicDylib,
442 "static-dylib" => LinkOutputKind::StaticDylib,
443 "wasi-reactor-exe" => LinkOutputKind::WasiReactorExe,
449 impl fmt::Display for LinkOutputKind {
450 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
451 f.write_str(self.as_str())
455 pub type LinkArgs = BTreeMap<LinkerFlavor, Vec<String>>;
457 #[derive(Clone, Copy, Hash, Debug, PartialEq, Eq)]
458 pub enum SplitDebuginfo {
459 /// Split debug-information is disabled, meaning that on supported platforms
460 /// you can find all debug information in the executable itself. This is
461 /// only supported for ELF effectively.
463 /// * Windows - not supported
464 /// * macOS - don't run `dsymutil`
465 /// * ELF - `.dwarf_*` sections
468 /// Split debug-information can be found in a "packed" location separate
469 /// from the final artifact. This is supported on all platforms.
471 /// * Windows - `*.pdb`
472 /// * macOS - `*.dSYM` (run `dsymutil`)
473 /// * ELF - `*.dwp` (run `rust-llvm-dwp`)
476 /// Split debug-information can be found in individual object files on the
477 /// filesystem. The main executable may point to the object files.
479 /// * Windows - not supported
480 /// * macOS - supported, scattered object files
481 /// * ELF - supported, scattered `*.dwo` files
485 impl SplitDebuginfo {
486 fn as_str(&self) -> &'static str {
488 SplitDebuginfo::Off => "off",
489 SplitDebuginfo::Packed => "packed",
490 SplitDebuginfo::Unpacked => "unpacked",
495 impl FromStr for SplitDebuginfo {
498 fn from_str(s: &str) -> Result<SplitDebuginfo, ()> {
500 "off" => SplitDebuginfo::Off,
501 "unpacked" => SplitDebuginfo::Unpacked,
502 "packed" => SplitDebuginfo::Packed,
508 impl ToJson for SplitDebuginfo {
509 fn to_json(&self) -> Json {
510 self.as_str().to_json()
514 impl fmt::Display for SplitDebuginfo {
515 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
516 f.write_str(self.as_str())
520 #[derive(Clone, Debug, PartialEq, Eq)]
521 pub enum StackProbeType {
522 /// Don't emit any stack probes.
524 /// It is harmless to use this option even on targets that do not have backend support for
525 /// stack probes as the failure mode is the same as if no stack-probe option was specified in
528 /// Call `__rust_probestack` whenever stack needs to be probed.
530 /// Use inline option for LLVM versions later than specified in `min_llvm_version_for_inline`
531 /// and call `__rust_probestack` otherwise.
532 InlineOrCall { min_llvm_version_for_inline: (u32, u32, u32) },
535 impl StackProbeType {
536 fn from_json(json: &Json) -> Result<Self, String> {
537 let object = json.as_object().ok_or_else(|| "expected a JSON object")?;
540 .and_then(|o| o.as_string())
541 .ok_or_else(|| "expected `kind` to be a string")?;
543 "none" => Ok(StackProbeType::None),
544 "inline" => Ok(StackProbeType::Inline),
545 "call" => Ok(StackProbeType::Call),
546 "inline-or-call" => {
547 let min_version = object
548 .get("min-llvm-version-for-inline")
549 .and_then(|o| o.as_array())
550 .ok_or_else(|| "expected `min-llvm-version-for-inline` to be an array")?;
551 let mut iter = min_version.into_iter().map(|v| {
552 let int = v.as_u64().ok_or_else(
553 || "expected `min-llvm-version-for-inline` values to be integers",
556 .map_err(|_| "`min-llvm-version-for-inline` values don't convert to u32")
558 let min_llvm_version_for_inline = (
559 iter.next().unwrap_or(Ok(11))?,
560 iter.next().unwrap_or(Ok(0))?,
561 iter.next().unwrap_or(Ok(0))?,
563 Ok(StackProbeType::InlineOrCall { min_llvm_version_for_inline })
565 _ => Err(String::from(
566 "`kind` expected to be one of `none`, `inline`, `call` or `inline-or-call`",
572 impl ToJson for StackProbeType {
573 fn to_json(&self) -> Json {
574 Json::Object(match self {
575 StackProbeType::None => {
576 vec![(String::from("kind"), "none".to_json())].into_iter().collect()
578 StackProbeType::Inline => {
579 vec![(String::from("kind"), "inline".to_json())].into_iter().collect()
581 StackProbeType::Call => {
582 vec![(String::from("kind"), "call".to_json())].into_iter().collect()
584 StackProbeType::InlineOrCall { min_llvm_version_for_inline } => vec![
585 (String::from("kind"), "inline-or-call".to_json()),
587 String::from("min-llvm-version-for-inline"),
588 min_llvm_version_for_inline.to_json(),
597 bitflags::bitflags! {
598 #[derive(Default, Encodable, Decodable)]
599 pub struct SanitizerSet: u8 {
600 const ADDRESS = 1 << 0;
602 const MEMORY = 1 << 2;
603 const THREAD = 1 << 3;
604 const HWADDRESS = 1 << 4;
610 /// Return sanitizer's name
612 /// Returns none if the flags is a set of sanitizers numbering not exactly one.
613 fn as_str(self) -> Option<&'static str> {
615 SanitizerSet::ADDRESS => "address",
616 SanitizerSet::CFI => "cfi",
617 SanitizerSet::LEAK => "leak",
618 SanitizerSet::MEMORY => "memory",
619 SanitizerSet::THREAD => "thread",
620 SanitizerSet::HWADDRESS => "hwaddress",
626 /// Formats a sanitizer set as a comma separated list of sanitizers' names.
627 impl fmt::Display for SanitizerSet {
628 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
629 let mut first = true;
631 let name = s.as_str().unwrap_or_else(|| panic!("unrecognized sanitizer {:?}", s));
642 impl IntoIterator for SanitizerSet {
643 type Item = SanitizerSet;
644 type IntoIter = std::vec::IntoIter<SanitizerSet>;
646 fn into_iter(self) -> Self::IntoIter {
648 SanitizerSet::ADDRESS,
651 SanitizerSet::MEMORY,
652 SanitizerSet::THREAD,
653 SanitizerSet::HWADDRESS,
657 .filter(|&s| self.contains(s))
663 impl<CTX> HashStable<CTX> for SanitizerSet {
664 fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher) {
665 self.bits().hash_stable(ctx, hasher);
669 impl ToJson for SanitizerSet {
670 fn to_json(&self) -> Json {
672 .map(|v| Some(v.as_str()?.to_json()))
673 .collect::<Option<Vec<_>>>()
679 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
680 pub enum FramePointer {
681 /// Forces the machine code generator to always preserve the frame pointers.
683 /// Forces the machine code generator to preserve the frame pointers except for the leaf
684 /// functions (i.e. those that don't call other functions).
686 /// Allows the machine code generator to omit the frame pointers.
688 /// This option does not guarantee that the frame pointers will be omitted.
692 impl FromStr for FramePointer {
694 fn from_str(s: &str) -> Result<Self, ()> {
696 "always" => Self::Always,
697 "non-leaf" => Self::NonLeaf,
698 "may-omit" => Self::MayOmit,
704 impl ToJson for FramePointer {
705 fn to_json(&self) -> Json {
707 Self::Always => "always",
708 Self::NonLeaf => "non-leaf",
709 Self::MayOmit => "may-omit",
715 macro_rules! supported_targets {
716 ( $(($( $triple:literal, )+ $module:ident ),)+ ) => {
719 /// List of supported targets
720 pub const TARGETS: &[&str] = &[$($($triple),+),+];
722 fn load_builtin(target: &str) -> Option<Target> {
723 let mut t = match target {
724 $( $($triple)|+ => $module::target(), )+
728 debug!("got builtin target: {:?}", t);
736 // Cannot put this into a separate file without duplication, make an exception.
740 tests_impl::test_target(super::$module::target());
748 ("x86_64-unknown-linux-gnu", x86_64_unknown_linux_gnu),
749 ("x86_64-unknown-linux-gnux32", x86_64_unknown_linux_gnux32),
750 ("i686-unknown-linux-gnu", i686_unknown_linux_gnu),
751 ("i586-unknown-linux-gnu", i586_unknown_linux_gnu),
752 ("m68k-unknown-linux-gnu", m68k_unknown_linux_gnu),
753 ("mips-unknown-linux-gnu", mips_unknown_linux_gnu),
754 ("mips64-unknown-linux-gnuabi64", mips64_unknown_linux_gnuabi64),
755 ("mips64el-unknown-linux-gnuabi64", mips64el_unknown_linux_gnuabi64),
756 ("mipsisa32r6-unknown-linux-gnu", mipsisa32r6_unknown_linux_gnu),
757 ("mipsisa32r6el-unknown-linux-gnu", mipsisa32r6el_unknown_linux_gnu),
758 ("mipsisa64r6-unknown-linux-gnuabi64", mipsisa64r6_unknown_linux_gnuabi64),
759 ("mipsisa64r6el-unknown-linux-gnuabi64", mipsisa64r6el_unknown_linux_gnuabi64),
760 ("mipsel-unknown-linux-gnu", mipsel_unknown_linux_gnu),
761 ("powerpc-unknown-linux-gnu", powerpc_unknown_linux_gnu),
762 ("powerpc-unknown-linux-gnuspe", powerpc_unknown_linux_gnuspe),
763 ("powerpc-unknown-linux-musl", powerpc_unknown_linux_musl),
764 ("powerpc64-unknown-linux-gnu", powerpc64_unknown_linux_gnu),
765 ("powerpc64-unknown-linux-musl", powerpc64_unknown_linux_musl),
766 ("powerpc64le-unknown-linux-gnu", powerpc64le_unknown_linux_gnu),
767 ("powerpc64le-unknown-linux-musl", powerpc64le_unknown_linux_musl),
768 ("s390x-unknown-linux-gnu", s390x_unknown_linux_gnu),
769 ("s390x-unknown-linux-musl", s390x_unknown_linux_musl),
770 ("sparc-unknown-linux-gnu", sparc_unknown_linux_gnu),
771 ("sparc64-unknown-linux-gnu", sparc64_unknown_linux_gnu),
772 ("arm-unknown-linux-gnueabi", arm_unknown_linux_gnueabi),
773 ("arm-unknown-linux-gnueabihf", arm_unknown_linux_gnueabihf),
774 ("arm-unknown-linux-musleabi", arm_unknown_linux_musleabi),
775 ("arm-unknown-linux-musleabihf", arm_unknown_linux_musleabihf),
776 ("armv4t-unknown-linux-gnueabi", armv4t_unknown_linux_gnueabi),
777 ("armv5te-unknown-linux-gnueabi", armv5te_unknown_linux_gnueabi),
778 ("armv5te-unknown-linux-musleabi", armv5te_unknown_linux_musleabi),
779 ("armv5te-unknown-linux-uclibceabi", armv5te_unknown_linux_uclibceabi),
780 ("armv7-unknown-linux-gnueabi", armv7_unknown_linux_gnueabi),
781 ("armv7-unknown-linux-gnueabihf", armv7_unknown_linux_gnueabihf),
782 ("thumbv7neon-unknown-linux-gnueabihf", thumbv7neon_unknown_linux_gnueabihf),
783 ("thumbv7neon-unknown-linux-musleabihf", thumbv7neon_unknown_linux_musleabihf),
784 ("armv7-unknown-linux-musleabi", armv7_unknown_linux_musleabi),
785 ("armv7-unknown-linux-musleabihf", armv7_unknown_linux_musleabihf),
786 ("aarch64-unknown-linux-gnu", aarch64_unknown_linux_gnu),
787 ("aarch64-unknown-linux-musl", aarch64_unknown_linux_musl),
788 ("x86_64-unknown-linux-musl", x86_64_unknown_linux_musl),
789 ("i686-unknown-linux-musl", i686_unknown_linux_musl),
790 ("i586-unknown-linux-musl", i586_unknown_linux_musl),
791 ("mips-unknown-linux-musl", mips_unknown_linux_musl),
792 ("mipsel-unknown-linux-musl", mipsel_unknown_linux_musl),
793 ("mips64-unknown-linux-muslabi64", mips64_unknown_linux_muslabi64),
794 ("mips64el-unknown-linux-muslabi64", mips64el_unknown_linux_muslabi64),
795 ("hexagon-unknown-linux-musl", hexagon_unknown_linux_musl),
797 ("mips-unknown-linux-uclibc", mips_unknown_linux_uclibc),
798 ("mipsel-unknown-linux-uclibc", mipsel_unknown_linux_uclibc),
800 ("i686-linux-android", i686_linux_android),
801 ("x86_64-linux-android", x86_64_linux_android),
802 ("arm-linux-androideabi", arm_linux_androideabi),
803 ("armv7-linux-androideabi", armv7_linux_androideabi),
804 ("thumbv7neon-linux-androideabi", thumbv7neon_linux_androideabi),
805 ("aarch64-linux-android", aarch64_linux_android),
807 ("x86_64-unknown-none-linuxkernel", x86_64_unknown_none_linuxkernel),
809 ("aarch64-unknown-freebsd", aarch64_unknown_freebsd),
810 ("armv6-unknown-freebsd", armv6_unknown_freebsd),
811 ("armv7-unknown-freebsd", armv7_unknown_freebsd),
812 ("i686-unknown-freebsd", i686_unknown_freebsd),
813 ("powerpc-unknown-freebsd", powerpc_unknown_freebsd),
814 ("powerpc64-unknown-freebsd", powerpc64_unknown_freebsd),
815 ("powerpc64le-unknown-freebsd", powerpc64le_unknown_freebsd),
816 ("x86_64-unknown-freebsd", x86_64_unknown_freebsd),
818 ("x86_64-unknown-dragonfly", x86_64_unknown_dragonfly),
820 ("aarch64-unknown-openbsd", aarch64_unknown_openbsd),
821 ("i686-unknown-openbsd", i686_unknown_openbsd),
822 ("sparc64-unknown-openbsd", sparc64_unknown_openbsd),
823 ("x86_64-unknown-openbsd", x86_64_unknown_openbsd),
824 ("powerpc-unknown-openbsd", powerpc_unknown_openbsd),
826 ("aarch64-unknown-netbsd", aarch64_unknown_netbsd),
827 ("armv6-unknown-netbsd-eabihf", armv6_unknown_netbsd_eabihf),
828 ("armv7-unknown-netbsd-eabihf", armv7_unknown_netbsd_eabihf),
829 ("i686-unknown-netbsd", i686_unknown_netbsd),
830 ("powerpc-unknown-netbsd", powerpc_unknown_netbsd),
831 ("sparc64-unknown-netbsd", sparc64_unknown_netbsd),
832 ("x86_64-unknown-netbsd", x86_64_unknown_netbsd),
834 ("i686-unknown-haiku", i686_unknown_haiku),
835 ("x86_64-unknown-haiku", x86_64_unknown_haiku),
837 ("aarch64-apple-darwin", aarch64_apple_darwin),
838 ("x86_64-apple-darwin", x86_64_apple_darwin),
839 ("i686-apple-darwin", i686_apple_darwin),
841 ("aarch64-fuchsia", aarch64_fuchsia),
842 ("x86_64-fuchsia", x86_64_fuchsia),
844 ("avr-unknown-gnu-atmega328", avr_unknown_gnu_atmega328),
846 ("x86_64-unknown-l4re-uclibc", x86_64_unknown_l4re_uclibc),
848 ("aarch64-unknown-redox", aarch64_unknown_redox),
849 ("x86_64-unknown-redox", x86_64_unknown_redox),
851 ("i386-apple-ios", i386_apple_ios),
852 ("x86_64-apple-ios", x86_64_apple_ios),
853 ("aarch64-apple-ios", aarch64_apple_ios),
854 ("armv7-apple-ios", armv7_apple_ios),
855 ("armv7s-apple-ios", armv7s_apple_ios),
856 ("x86_64-apple-ios-macabi", x86_64_apple_ios_macabi),
857 ("aarch64-apple-ios-macabi", aarch64_apple_ios_macabi),
858 ("aarch64-apple-ios-sim", aarch64_apple_ios_sim),
859 ("aarch64-apple-tvos", aarch64_apple_tvos),
860 ("x86_64-apple-tvos", x86_64_apple_tvos),
862 ("armebv7r-none-eabi", armebv7r_none_eabi),
863 ("armebv7r-none-eabihf", armebv7r_none_eabihf),
864 ("armv7r-none-eabi", armv7r_none_eabi),
865 ("armv7r-none-eabihf", armv7r_none_eabihf),
867 ("x86_64-pc-solaris", x86_64_pc_solaris),
868 ("x86_64-sun-solaris", x86_64_sun_solaris),
869 ("sparcv9-sun-solaris", sparcv9_sun_solaris),
871 ("x86_64-unknown-illumos", x86_64_unknown_illumos),
873 ("x86_64-pc-windows-gnu", x86_64_pc_windows_gnu),
874 ("i686-pc-windows-gnu", i686_pc_windows_gnu),
875 ("i686-uwp-windows-gnu", i686_uwp_windows_gnu),
876 ("x86_64-uwp-windows-gnu", x86_64_uwp_windows_gnu),
878 ("aarch64-pc-windows-msvc", aarch64_pc_windows_msvc),
879 ("aarch64-uwp-windows-msvc", aarch64_uwp_windows_msvc),
880 ("x86_64-pc-windows-msvc", x86_64_pc_windows_msvc),
881 ("x86_64-uwp-windows-msvc", x86_64_uwp_windows_msvc),
882 ("i686-pc-windows-msvc", i686_pc_windows_msvc),
883 ("i686-uwp-windows-msvc", i686_uwp_windows_msvc),
884 ("i586-pc-windows-msvc", i586_pc_windows_msvc),
885 ("thumbv7a-pc-windows-msvc", thumbv7a_pc_windows_msvc),
886 ("thumbv7a-uwp-windows-msvc", thumbv7a_uwp_windows_msvc),
888 ("asmjs-unknown-emscripten", asmjs_unknown_emscripten),
889 ("wasm32-unknown-emscripten", wasm32_unknown_emscripten),
890 ("wasm32-unknown-unknown", wasm32_unknown_unknown),
891 ("wasm32-wasi", wasm32_wasi),
892 ("wasm64-unknown-unknown", wasm64_unknown_unknown),
894 ("thumbv6m-none-eabi", thumbv6m_none_eabi),
895 ("thumbv7m-none-eabi", thumbv7m_none_eabi),
896 ("thumbv7em-none-eabi", thumbv7em_none_eabi),
897 ("thumbv7em-none-eabihf", thumbv7em_none_eabihf),
898 ("thumbv8m.base-none-eabi", thumbv8m_base_none_eabi),
899 ("thumbv8m.main-none-eabi", thumbv8m_main_none_eabi),
900 ("thumbv8m.main-none-eabihf", thumbv8m_main_none_eabihf),
902 ("armv7a-none-eabi", armv7a_none_eabi),
903 ("armv7a-none-eabihf", armv7a_none_eabihf),
905 ("msp430-none-elf", msp430_none_elf),
907 ("aarch64-unknown-hermit", aarch64_unknown_hermit),
908 ("x86_64-unknown-hermit", x86_64_unknown_hermit),
910 ("x86_64-unknown-none-hermitkernel", x86_64_unknown_none_hermitkernel),
912 ("riscv32i-unknown-none-elf", riscv32i_unknown_none_elf),
913 ("riscv32imc-unknown-none-elf", riscv32imc_unknown_none_elf),
914 ("riscv32imc-esp-espidf", riscv32imc_esp_espidf),
915 ("riscv32imac-unknown-none-elf", riscv32imac_unknown_none_elf),
916 ("riscv32gc-unknown-linux-gnu", riscv32gc_unknown_linux_gnu),
917 ("riscv32gc-unknown-linux-musl", riscv32gc_unknown_linux_musl),
918 ("riscv64imac-unknown-none-elf", riscv64imac_unknown_none_elf),
919 ("riscv64gc-unknown-none-elf", riscv64gc_unknown_none_elf),
920 ("riscv64gc-unknown-linux-gnu", riscv64gc_unknown_linux_gnu),
921 ("riscv64gc-unknown-linux-musl", riscv64gc_unknown_linux_musl),
923 ("aarch64-unknown-none", aarch64_unknown_none),
924 ("aarch64-unknown-none-softfloat", aarch64_unknown_none_softfloat),
926 ("x86_64-fortanix-unknown-sgx", x86_64_fortanix_unknown_sgx),
928 ("x86_64-unknown-uefi", x86_64_unknown_uefi),
929 ("i686-unknown-uefi", i686_unknown_uefi),
930 ("aarch64-unknown-uefi", aarch64_unknown_uefi),
932 ("nvptx64-nvidia-cuda", nvptx64_nvidia_cuda),
934 ("i686-wrs-vxworks", i686_wrs_vxworks),
935 ("x86_64-wrs-vxworks", x86_64_wrs_vxworks),
936 ("armv7-wrs-vxworks-eabihf", armv7_wrs_vxworks_eabihf),
937 ("aarch64-wrs-vxworks", aarch64_wrs_vxworks),
938 ("powerpc-wrs-vxworks", powerpc_wrs_vxworks),
939 ("powerpc-wrs-vxworks-spe", powerpc_wrs_vxworks_spe),
940 ("powerpc64-wrs-vxworks", powerpc64_wrs_vxworks),
942 ("aarch64-kmc-solid_asp3", aarch64_kmc_solid_asp3),
943 ("armv7a-kmc-solid_asp3-eabi", armv7a_kmc_solid_asp3_eabi),
944 ("armv7a-kmc-solid_asp3-eabihf", armv7a_kmc_solid_asp3_eabihf),
946 ("mipsel-sony-psp", mipsel_sony_psp),
947 ("mipsel-unknown-none", mipsel_unknown_none),
948 ("thumbv4t-none-eabi", thumbv4t_none_eabi),
950 ("aarch64_be-unknown-linux-gnu", aarch64_be_unknown_linux_gnu),
951 ("aarch64-unknown-linux-gnu_ilp32", aarch64_unknown_linux_gnu_ilp32),
952 ("aarch64_be-unknown-linux-gnu_ilp32", aarch64_be_unknown_linux_gnu_ilp32),
954 ("bpfeb-unknown-none", bpfeb_unknown_none),
955 ("bpfel-unknown-none", bpfel_unknown_none),
957 ("armv6k-nintendo-3ds", armv6k_nintendo_3ds),
959 ("armv7-unknown-linux-uclibceabihf", armv7_unknown_linux_uclibceabihf),
962 /// Warnings encountered when parsing the target `json`.
964 /// Includes fields that weren't recognized and fields that don't have the expected type.
965 #[derive(Debug, PartialEq)]
966 pub struct TargetWarnings {
967 unused_fields: Vec<String>,
968 incorrect_type: Vec<String>,
971 impl TargetWarnings {
972 pub fn empty() -> Self {
973 Self { unused_fields: Vec::new(), incorrect_type: Vec::new() }
976 pub fn warning_messages(&self) -> Vec<String> {
977 let mut warnings = vec![];
978 if !self.unused_fields.is_empty() {
979 warnings.push(format!(
980 "target json file contains unused fields: {}",
981 self.unused_fields.join(", ")
984 if !self.incorrect_type.is_empty() {
985 warnings.push(format!(
986 "target json file contains fields whose value doesn't have the correct json type: {}",
987 self.incorrect_type.join(", ")
994 /// Everything `rustc` knows about how to compile for a specific target.
996 /// Every field here must be specified, and has no default value.
997 #[derive(PartialEq, Clone, Debug)]
999 /// Target triple to pass to LLVM.
1000 pub llvm_target: String,
1001 /// Number of bits in a pointer. Influences the `target_pointer_width` `cfg` variable.
1002 pub pointer_width: u32,
1003 /// Architecture to use for ABI considerations. Valid options include: "x86",
1004 /// "x86_64", "arm", "aarch64", "mips", "powerpc", "powerpc64", and others.
1006 /// [Data layout](https://llvm.org/docs/LangRef.html#data-layout) to pass to LLVM.
1007 pub data_layout: String,
1008 /// Optional settings with defaults.
1009 pub options: TargetOptions,
1012 pub trait HasTargetSpec {
1013 fn target_spec(&self) -> &Target;
1016 impl HasTargetSpec for Target {
1018 fn target_spec(&self) -> &Target {
1023 /// Optional aspects of a target specification.
1025 /// This has an implementation of `Default`, see each field for what the default is. In general,
1026 /// these try to take "minimal defaults" that don't assume anything about the runtime they run in.
1028 /// `TargetOptions` as a separate structure is mostly an implementation detail of `Target`
1029 /// construction, all its fields logically belong to `Target` and available from `Target`
1030 /// through `Deref` impls.
1031 #[derive(PartialEq, Clone, Debug)]
1032 pub struct TargetOptions {
1033 /// Whether the target is built-in or loaded from a custom target specification.
1034 pub is_builtin: bool,
1036 /// Used as the `target_endian` `cfg` variable. Defaults to little endian.
1038 /// Width of c_int type. Defaults to "32".
1039 pub c_int_width: String,
1040 /// OS name to use for conditional compilation (`target_os`). Defaults to "none".
1041 /// "none" implies a bare metal target without `std` library.
1042 /// A couple of targets having `std` also use "unknown" as an `os` value,
1043 /// but they are exceptions.
1045 /// Environment name to use for conditional compilation (`target_env`). Defaults to "".
1047 /// ABI name to distinguish multiple ABIs on the same OS and architecture. For instance, `"eabi"`
1048 /// or `"eabihf"`. Defaults to "".
1050 /// Vendor name to use for conditional compilation (`target_vendor`). Defaults to "unknown".
1052 /// Default linker flavor used if `-C linker-flavor` or `-C linker` are not passed
1053 /// on the command line. Defaults to `LinkerFlavor::Gcc`.
1054 pub linker_flavor: LinkerFlavor,
1056 /// Linker to invoke
1057 pub linker: Option<String>,
1059 /// LLD flavor used if `lld` (or `rust-lld`) is specified as a linker
1060 /// without clarifying its flavor in any way.
1061 pub lld_flavor: LldFlavor,
1063 /// Linker arguments that are passed *before* any user-defined libraries.
1064 pub pre_link_args: LinkArgs,
1065 /// Objects to link before and after all other object code.
1066 pub pre_link_objects: CrtObjects,
1067 pub post_link_objects: CrtObjects,
1068 /// Same as `(pre|post)_link_objects`, but when we fail to pull the objects with help of the
1069 /// target's native gcc and fall back to the "self-contained" mode and pull them manually.
1070 /// See `crt_objects.rs` for some more detailed documentation.
1071 pub pre_link_objects_fallback: CrtObjects,
1072 pub post_link_objects_fallback: CrtObjects,
1073 /// Which logic to use to determine whether to fall back to the "self-contained" mode or not.
1074 pub crt_objects_fallback: Option<CrtObjectsFallback>,
1076 /// Linker arguments that are unconditionally passed after any
1077 /// user-defined but before post-link objects. Standard platform
1078 /// libraries that should be always be linked to, usually go here.
1079 pub late_link_args: LinkArgs,
1080 /// Linker arguments used in addition to `late_link_args` if at least one
1081 /// Rust dependency is dynamically linked.
1082 pub late_link_args_dynamic: LinkArgs,
1083 /// Linker arguments used in addition to `late_link_args` if aall Rust
1084 /// dependencies are statically linked.
1085 pub late_link_args_static: LinkArgs,
1086 /// Linker arguments that are unconditionally passed *after* any
1087 /// user-defined libraries.
1088 pub post_link_args: LinkArgs,
1089 /// Optional link script applied to `dylib` and `executable` crate types.
1090 /// This is a string containing the script, not a path. Can only be applied
1091 /// to linkers where `linker_is_gnu` is true.
1092 pub link_script: Option<String>,
1094 /// Environment variables to be set for the linker invocation.
1095 pub link_env: Vec<(String, String)>,
1096 /// Environment variables to be removed for the linker invocation.
1097 pub link_env_remove: Vec<String>,
1099 /// Extra arguments to pass to the external assembler (when used)
1100 pub asm_args: Vec<String>,
1102 /// Default CPU to pass to LLVM. Corresponds to `llc -mcpu=$cpu`. Defaults
1105 /// Default target features to pass to LLVM. These features will *always* be
1106 /// passed, and cannot be disabled even via `-C`. Corresponds to `llc
1107 /// -mattr=$features`.
1108 pub features: String,
1109 /// Whether dynamic linking is available on this target. Defaults to false.
1110 pub dynamic_linking: bool,
1111 /// If dynamic linking is available, whether only cdylibs are supported.
1112 pub only_cdylib: bool,
1113 /// Whether executables are available on this target. iOS, for example, only allows static
1114 /// libraries. Defaults to false.
1115 pub executables: bool,
1116 /// Relocation model to use in object file. Corresponds to `llc
1117 /// -relocation-model=$relocation_model`. Defaults to `Pic`.
1118 pub relocation_model: RelocModel,
1119 /// Code model to use. Corresponds to `llc -code-model=$code_model`.
1120 /// Defaults to `None` which means "inherited from the base LLVM target".
1121 pub code_model: Option<CodeModel>,
1122 /// TLS model to use. Options are "global-dynamic" (default), "local-dynamic", "initial-exec"
1123 /// and "local-exec". This is similar to the -ftls-model option in GCC/Clang.
1124 pub tls_model: TlsModel,
1125 /// Do not emit code that uses the "red zone", if the ABI has one. Defaults to false.
1126 pub disable_redzone: bool,
1127 /// Frame pointer mode for this target. Defaults to `MayOmit`.
1128 pub frame_pointer: FramePointer,
1129 /// Emit each function in its own section. Defaults to true.
1130 pub function_sections: bool,
1131 /// String to prepend to the name of every dynamic library. Defaults to "lib".
1132 pub dll_prefix: String,
1133 /// String to append to the name of every dynamic library. Defaults to ".so".
1134 pub dll_suffix: String,
1135 /// String to append to the name of every executable.
1136 pub exe_suffix: String,
1137 /// String to prepend to the name of every static library. Defaults to "lib".
1138 pub staticlib_prefix: String,
1139 /// String to append to the name of every static library. Defaults to ".a".
1140 pub staticlib_suffix: String,
1141 /// Values of the `target_family` cfg set for this target.
1143 /// Common options are: "unix", "windows". Defaults to no families.
1145 /// See <https://doc.rust-lang.org/reference/conditional-compilation.html#target_family>.
1146 pub families: Vec<String>,
1147 /// Whether the target toolchain's ABI supports returning small structs as an integer.
1148 pub abi_return_struct_as_int: bool,
1149 /// Whether the target toolchain is like macOS's. Only useful for compiling against iOS/macOS,
1150 /// in particular running dsymutil and some other stuff like `-dead_strip`. Defaults to false.
1151 pub is_like_osx: bool,
1152 /// Whether the target toolchain is like Solaris's.
1153 /// Only useful for compiling against Illumos/Solaris,
1154 /// as they have a different set of linker flags. Defaults to false.
1155 pub is_like_solaris: bool,
1156 /// Whether the target is like Windows.
1157 /// This is a combination of several more specific properties represented as a single flag:
1158 /// - The target uses a Windows ABI,
1159 /// - uses PE/COFF as a format for object code,
1160 /// - uses Windows-style dllexport/dllimport for shared libraries,
1161 /// - uses import libraries and .def files for symbol exports,
1162 /// - executables support setting a subsystem.
1163 pub is_like_windows: bool,
1164 /// Whether the target is like MSVC.
1165 /// This is a combination of several more specific properties represented as a single flag:
1166 /// - The target has all the properties from `is_like_windows`
1167 /// (for in-tree targets "is_like_msvc ⇒ is_like_windows" is ensured by a unit test),
1168 /// - has some MSVC-specific Windows ABI properties,
1169 /// - uses a link.exe-like linker,
1170 /// - uses CodeView/PDB for debuginfo and natvis for its visualization,
1171 /// - uses SEH-based unwinding,
1172 /// - supports control flow guard mechanism.
1173 pub is_like_msvc: bool,
1174 /// Whether the target toolchain is like Emscripten's. Only useful for compiling with
1175 /// Emscripten toolchain.
1176 /// Defaults to false.
1177 pub is_like_emscripten: bool,
1178 /// Whether the target toolchain is like Fuchsia's.
1179 pub is_like_fuchsia: bool,
1180 /// Whether a target toolchain is like WASM.
1181 pub is_like_wasm: bool,
1182 /// Version of DWARF to use if not using the default.
1183 /// Useful because some platforms (osx, bsd) only want up to DWARF2.
1184 pub dwarf_version: Option<u32>,
1185 /// Whether the linker support GNU-like arguments such as -O. Defaults to true.
1186 pub linker_is_gnu: bool,
1187 /// The MinGW toolchain has a known issue that prevents it from correctly
1188 /// handling COFF object files with more than 2<sup>15</sup> sections. Since each weak
1189 /// symbol needs its own COMDAT section, weak linkage implies a large
1190 /// number sections that easily exceeds the given limit for larger
1191 /// codebases. Consequently we want a way to disallow weak linkage on some
1193 pub allows_weak_linkage: bool,
1194 /// Whether the linker support rpaths or not. Defaults to false.
1195 pub has_rpath: bool,
1196 /// Whether to disable linking to the default libraries, typically corresponds
1197 /// to `-nodefaultlibs`. Defaults to true.
1198 pub no_default_libraries: bool,
1199 /// Dynamically linked executables can be compiled as position independent
1200 /// if the default relocation model of position independent code is not
1201 /// changed. This is a requirement to take advantage of ASLR, as otherwise
1202 /// the functions in the executable are not randomized and can be used
1203 /// during an exploit of a vulnerability in any code.
1204 pub position_independent_executables: bool,
1205 /// Executables that are both statically linked and position-independent are supported.
1206 pub static_position_independent_executables: bool,
1207 /// Determines if the target always requires using the PLT for indirect
1208 /// library calls or not. This controls the default value of the `-Z plt` flag.
1209 pub needs_plt: bool,
1210 /// Either partial, full, or off. Full RELRO makes the dynamic linker
1211 /// resolve all symbols at startup and marks the GOT read-only before
1212 /// starting the program, preventing overwriting the GOT.
1213 pub relro_level: RelroLevel,
1214 /// Format that archives should be emitted in. This affects whether we use
1215 /// LLVM to assemble an archive or fall back to the system linker, and
1216 /// currently only "gnu" is used to fall into LLVM. Unknown strings cause
1217 /// the system linker to be used.
1218 pub archive_format: String,
1219 /// Is asm!() allowed? Defaults to true.
1220 pub allow_asm: bool,
1221 /// Whether the runtime startup code requires the `main` function be passed
1222 /// `argc` and `argv` values.
1223 pub main_needs_argc_argv: bool,
1225 /// Flag indicating whether ELF TLS (e.g., #[thread_local]) is available for
1227 pub has_elf_tls: bool,
1228 // This is mainly for easy compatibility with emscripten.
1229 // If we give emcc .o files that are actually .bc files it
1230 // will 'just work'.
1231 pub obj_is_bitcode: bool,
1232 /// Whether the target requires that emitted object code includes bitcode.
1233 pub forces_embed_bitcode: bool,
1234 /// Content of the LLVM cmdline section associated with embedded bitcode.
1235 pub bitcode_llvm_cmdline: String,
1237 /// Don't use this field; instead use the `.min_atomic_width()` method.
1238 pub min_atomic_width: Option<u64>,
1240 /// Don't use this field; instead use the `.max_atomic_width()` method.
1241 pub max_atomic_width: Option<u64>,
1243 /// Whether the target supports atomic CAS operations natively
1244 pub atomic_cas: bool,
1246 /// Panic strategy: "unwind" or "abort"
1247 pub panic_strategy: PanicStrategy,
1249 /// Whether or not linking dylibs to a static CRT is allowed.
1250 pub crt_static_allows_dylibs: bool,
1251 /// Whether or not the CRT is statically linked by default.
1252 pub crt_static_default: bool,
1253 /// Whether or not crt-static is respected by the compiler (or is a no-op).
1254 pub crt_static_respected: bool,
1256 /// The implementation of stack probes to use.
1257 pub stack_probes: StackProbeType,
1259 /// The minimum alignment for global symbols.
1260 pub min_global_align: Option<u64>,
1262 /// Default number of codegen units to use in debug mode
1263 pub default_codegen_units: Option<u64>,
1265 /// Whether to generate trap instructions in places where optimization would
1266 /// otherwise produce control flow that falls through into unrelated memory.
1267 pub trap_unreachable: bool,
1269 /// This target requires everything to be compiled with LTO to emit a final
1270 /// executable, aka there is no native linker for this target.
1271 pub requires_lto: bool,
1273 /// This target has no support for threads.
1274 pub singlethread: bool,
1276 /// Whether library functions call lowering/optimization is disabled in LLVM
1277 /// for this target unconditionally.
1278 pub no_builtins: bool,
1280 /// The default visibility for symbols in this target should be "hidden"
1281 /// rather than "default"
1282 pub default_hidden_visibility: bool,
1284 /// Whether a .debug_gdb_scripts section will be added to the output object file
1285 pub emit_debug_gdb_scripts: bool,
1287 /// Whether or not to unconditionally `uwtable` attributes on functions,
1288 /// typically because the platform needs to unwind for things like stack
1290 pub requires_uwtable: bool,
1292 /// Whether or not to emit `uwtable` attributes on functions if `-C force-unwind-tables`
1293 /// is not specified and `uwtable` is not required on this target.
1294 pub default_uwtable: bool,
1296 /// Whether or not SIMD types are passed by reference in the Rust ABI,
1297 /// typically required if a target can be compiled with a mixed set of
1298 /// target features. This is `true` by default, and `false` for targets like
1299 /// wasm32 where the whole program either has simd or not.
1300 pub simd_types_indirect: bool,
1302 /// Pass a list of symbol which should be exported in the dylib to the linker.
1303 pub limit_rdylib_exports: bool,
1305 /// If set, have the linker export exactly these symbols, instead of using
1306 /// the usual logic to figure this out from the crate itself.
1307 pub override_export_symbols: Option<Vec<String>>,
1309 /// Determines how or whether the MergeFunctions LLVM pass should run for
1310 /// this target. Either "disabled", "trampolines", or "aliases".
1311 /// The MergeFunctions pass is generally useful, but some targets may need
1312 /// to opt out. The default is "aliases".
1314 /// Workaround for: <https://github.com/rust-lang/rust/issues/57356>
1315 pub merge_functions: MergeFunctions,
1317 /// Use platform dependent mcount function
1320 /// LLVM ABI name, corresponds to the '-mabi' parameter available in multilib C compilers
1321 pub llvm_abiname: String,
1323 /// Whether or not RelaxElfRelocation flag will be passed to the linker
1324 pub relax_elf_relocations: bool,
1326 /// Additional arguments to pass to LLVM, similar to the `-C llvm-args` codegen option.
1327 pub llvm_args: Vec<String>,
1329 /// Whether to use legacy .ctors initialization hooks rather than .init_array. Defaults
1330 /// to false (uses .init_array).
1331 pub use_ctors_section: bool,
1333 /// Whether the linker is instructed to add a `GNU_EH_FRAME` ELF header
1334 /// used to locate unwinding information is passed
1335 /// (only has effect if the linker is `ld`-like).
1336 pub eh_frame_header: bool,
1338 /// Is true if the target is an ARM architecture using thumb v1 which allows for
1339 /// thumb and arm interworking.
1340 pub has_thumb_interworking: bool,
1342 /// How to handle split debug information, if at all. Specifying `None` has
1343 /// target-specific meaning.
1344 pub split_debuginfo: SplitDebuginfo,
1346 /// The sanitizers supported by this target
1348 /// Note that the support here is at a codegen level. If the machine code with sanitizer
1349 /// enabled can generated on this target, but the necessary supporting libraries are not
1350 /// distributed with the target, the sanitizer should still appear in this list for the target.
1351 pub supported_sanitizers: SanitizerSet,
1353 /// If present it's a default value to use for adjusting the C ABI.
1354 pub default_adjusted_cabi: Option<Abi>,
1356 /// Minimum number of bits in #[repr(C)] enum. Defaults to 32.
1357 pub c_enum_min_bits: u64,
1360 impl Default for TargetOptions {
1361 /// Creates a set of "sane defaults" for any target. This is still
1362 /// incomplete, and if used for compilation, will certainly not work.
1363 fn default() -> TargetOptions {
1366 endian: Endian::Little,
1367 c_int_width: "32".to_string(),
1368 os: "none".to_string(),
1371 vendor: "unknown".to_string(),
1372 linker_flavor: LinkerFlavor::Gcc,
1373 linker: option_env!("CFG_DEFAULT_LINKER").map(|s| s.to_string()),
1374 lld_flavor: LldFlavor::Ld,
1375 pre_link_args: LinkArgs::new(),
1376 post_link_args: LinkArgs::new(),
1378 asm_args: Vec::new(),
1379 cpu: "generic".to_string(),
1380 features: String::new(),
1381 dynamic_linking: false,
1384 relocation_model: RelocModel::Pic,
1386 tls_model: TlsModel::GeneralDynamic,
1387 disable_redzone: false,
1388 frame_pointer: FramePointer::MayOmit,
1389 function_sections: true,
1390 dll_prefix: "lib".to_string(),
1391 dll_suffix: ".so".to_string(),
1392 exe_suffix: String::new(),
1393 staticlib_prefix: "lib".to_string(),
1394 staticlib_suffix: ".a".to_string(),
1395 families: Vec::new(),
1396 abi_return_struct_as_int: false,
1398 is_like_solaris: false,
1399 is_like_windows: false,
1400 is_like_emscripten: false,
1401 is_like_msvc: false,
1402 is_like_fuchsia: false,
1403 is_like_wasm: false,
1404 dwarf_version: None,
1405 linker_is_gnu: true,
1406 allows_weak_linkage: true,
1408 no_default_libraries: true,
1409 position_independent_executables: false,
1410 static_position_independent_executables: false,
1412 relro_level: RelroLevel::None,
1413 pre_link_objects: Default::default(),
1414 post_link_objects: Default::default(),
1415 pre_link_objects_fallback: Default::default(),
1416 post_link_objects_fallback: Default::default(),
1417 crt_objects_fallback: None,
1418 late_link_args: LinkArgs::new(),
1419 late_link_args_dynamic: LinkArgs::new(),
1420 late_link_args_static: LinkArgs::new(),
1421 link_env: Vec::new(),
1422 link_env_remove: Vec::new(),
1423 archive_format: "gnu".to_string(),
1424 main_needs_argc_argv: true,
1427 obj_is_bitcode: false,
1428 forces_embed_bitcode: false,
1429 bitcode_llvm_cmdline: String::new(),
1430 min_atomic_width: None,
1431 max_atomic_width: None,
1433 panic_strategy: PanicStrategy::Unwind,
1434 crt_static_allows_dylibs: false,
1435 crt_static_default: false,
1436 crt_static_respected: false,
1437 stack_probes: StackProbeType::None,
1438 min_global_align: None,
1439 default_codegen_units: None,
1440 trap_unreachable: true,
1441 requires_lto: false,
1442 singlethread: false,
1444 default_hidden_visibility: false,
1445 emit_debug_gdb_scripts: true,
1446 requires_uwtable: false,
1447 default_uwtable: false,
1448 simd_types_indirect: true,
1449 limit_rdylib_exports: true,
1450 override_export_symbols: None,
1451 merge_functions: MergeFunctions::Aliases,
1452 mcount: "mcount".to_string(),
1453 llvm_abiname: "".to_string(),
1454 relax_elf_relocations: false,
1456 use_ctors_section: false,
1457 eh_frame_header: true,
1458 has_thumb_interworking: false,
1459 split_debuginfo: SplitDebuginfo::Off,
1460 supported_sanitizers: SanitizerSet::empty(),
1461 default_adjusted_cabi: None,
1462 c_enum_min_bits: 32,
1467 /// `TargetOptions` being a separate type is basically an implementation detail of `Target` that is
1468 /// used for providing defaults. Perhaps there's a way to merge `TargetOptions` into `Target` so
1469 /// this `Deref` implementation is no longer necessary.
1470 impl Deref for Target {
1471 type Target = TargetOptions;
1473 fn deref(&self) -> &Self::Target {
1477 impl DerefMut for Target {
1478 fn deref_mut(&mut self) -> &mut Self::Target {
1484 /// Given a function ABI, turn it into the correct ABI for this target.
1485 pub fn adjust_abi(&self, abi: Abi) -> Abi {
1487 Abi::C { .. } => self.default_adjusted_cabi.unwrap_or(abi),
1488 Abi::System { unwind } if self.is_like_windows && self.arch == "x86" => {
1489 Abi::Stdcall { unwind }
1491 Abi::System { unwind } => Abi::C { unwind },
1492 Abi::EfiApi if self.arch == "x86_64" => Abi::Win64,
1493 Abi::EfiApi => Abi::C { unwind: false },
1495 // See commentary in `is_abi_supported`.
1496 Abi::Stdcall { .. } | Abi::Thiscall { .. } if self.arch == "x86" => abi,
1497 Abi::Stdcall { unwind } | Abi::Thiscall { unwind } => Abi::C { unwind },
1498 Abi::Fastcall if self.arch == "x86" => abi,
1499 Abi::Vectorcall if ["x86", "x86_64"].contains(&&self.arch[..]) => abi,
1500 Abi::Fastcall | Abi::Vectorcall => Abi::C { unwind: false },
1506 /// Returns a None if the UNSUPPORTED_CALLING_CONVENTIONS lint should be emitted
1507 pub fn is_abi_supported(&self, abi: Abi) -> Option<bool> {
1519 X86Interrupt => ["x86", "x86_64"].contains(&&self.arch[..]),
1520 Aapcs => "arm" == self.arch,
1521 CCmseNonSecureCall => ["arm", "aarch64"].contains(&&self.arch[..]),
1522 Win64 | SysV64 => self.arch == "x86_64",
1523 PtxKernel => self.arch == "nvptx64",
1524 Msp430Interrupt => self.arch == "msp430",
1525 AmdGpuKernel => self.arch == "amdgcn",
1526 AvrInterrupt | AvrNonBlockingInterrupt => self.arch == "avr",
1527 Wasm => ["wasm32", "wasm64"].contains(&&self.arch[..]),
1528 Thiscall { .. } => self.arch == "x86",
1529 // On windows these fall-back to platform native calling convention (C) when the
1530 // architecture is not supported.
1532 // This is I believe a historical accident that has occurred as part of Microsoft
1533 // striving to allow most of the code to "just" compile when support for 64-bit x86
1534 // was added and then later again, when support for ARM architectures was added.
1536 // This is well documented across MSDN. Support for this in Rust has been added in
1537 // #54576. This makes much more sense in context of Microsoft's C++ than it does in
1538 // Rust, but there isn't much leeway remaining here to change it back at the time this
1539 // comment has been written.
1541 // Following are the relevant excerpts from the MSDN documentation.
1543 // > The __vectorcall calling convention is only supported in native code on x86 and
1544 // x64 processors that include Streaming SIMD Extensions 2 (SSE2) and above.
1546 // > On ARM machines, __vectorcall is accepted and ignored by the compiler.
1548 // -- https://docs.microsoft.com/en-us/cpp/cpp/vectorcall?view=msvc-160
1550 // > On ARM and x64 processors, __stdcall is accepted and ignored by the compiler;
1552 // -- https://docs.microsoft.com/en-us/cpp/cpp/stdcall?view=msvc-160
1554 // > In most cases, keywords or compiler switches that specify an unsupported
1555 // > convention on a particular platform are ignored, and the platform default
1556 // > convention is used.
1558 // -- https://docs.microsoft.com/en-us/cpp/cpp/argument-passing-and-naming-conventions
1559 Stdcall { .. } | Fastcall | Vectorcall if self.is_like_windows => true,
1560 // Outside of Windows we want to only support these calling conventions for the
1561 // architectures for which these calling conventions are actually well defined.
1562 Stdcall { .. } | Fastcall if self.arch == "x86" => true,
1563 Vectorcall if ["x86", "x86_64"].contains(&&self.arch[..]) => true,
1564 // Return a `None` for other cases so that we know to emit a future compat lint.
1565 Stdcall { .. } | Fastcall | Vectorcall => return None,
1569 /// Minimum integer size in bits that this target can perform atomic
1571 pub fn min_atomic_width(&self) -> u64 {
1572 self.min_atomic_width.unwrap_or(8)
1575 /// Maximum integer size in bits that this target can perform atomic
1577 pub fn max_atomic_width(&self) -> u64 {
1578 self.max_atomic_width.unwrap_or_else(|| self.pointer_width.into())
1581 /// Loads a target descriptor from a JSON object.
1582 pub fn from_json(mut obj: Json) -> Result<(Target, TargetWarnings), String> {
1583 // While ugly, this code must remain this way to retain
1584 // compatibility with existing JSON fields and the internal
1585 // expected naming of the Target and TargetOptions structs.
1586 // To ensure compatibility is retained, the built-in targets
1587 // are round-tripped through this code to catch cases where
1588 // the JSON parser is not updated to match the structs.
1590 let mut get_req_field = |name: &str| {
1591 obj.remove_key(name)
1592 .and_then(|j| Json::as_string(&j).map(str::to_string))
1593 .ok_or_else(|| format!("Field {} in target specification is required", name))
1596 let mut base = Target {
1597 llvm_target: get_req_field("llvm-target")?,
1598 pointer_width: get_req_field("target-pointer-width")?
1600 .map_err(|_| "target-pointer-width must be an integer".to_string())?,
1601 data_layout: get_req_field("data-layout")?,
1602 arch: get_req_field("arch")?,
1603 options: Default::default(),
1606 let mut incorrect_type = vec![];
1609 ($key_name:ident) => ( {
1610 let name = (stringify!($key_name)).replace("_", "-");
1611 if let Some(s) = obj.remove_key(&name).and_then(|j| Json::as_string(&j).map(str::to_string)) {
1615 ($key_name:ident = $json_name:expr) => ( {
1616 let name = $json_name;
1617 if let Some(s) = obj.remove_key(&name).and_then(|j| Json::as_string(&j).map(str::to_string)) {
1621 ($key_name:ident, bool) => ( {
1622 let name = (stringify!($key_name)).replace("_", "-");
1623 if let Some(s) = obj.remove_key(&name).and_then(|j| Json::as_boolean(&j)) {
1627 ($key_name:ident, u64) => ( {
1628 let name = (stringify!($key_name)).replace("_", "-");
1629 if let Some(s) = obj.remove_key(&name).and_then(|j| Json::as_u64(&j)) {
1633 ($key_name:ident, Option<u32>) => ( {
1634 let name = (stringify!($key_name)).replace("_", "-");
1635 if let Some(s) = obj.remove_key(&name).and_then(|j| Json::as_u64(&j)) {
1637 return Err("Not a valid DWARF version number".to_string());
1639 base.$key_name = Some(s as u32);
1642 ($key_name:ident, Option<u64>) => ( {
1643 let name = (stringify!($key_name)).replace("_", "-");
1644 if let Some(s) = obj.remove_key(&name).and_then(|j| Json::as_u64(&j)) {
1645 base.$key_name = Some(s);
1648 ($key_name:ident, MergeFunctions) => ( {
1649 let name = (stringify!($key_name)).replace("_", "-");
1650 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1651 match s.parse::<MergeFunctions>() {
1652 Ok(mergefunc) => base.$key_name = mergefunc,
1653 _ => return Some(Err(format!("'{}' is not a valid value for \
1654 merge-functions. Use 'disabled', \
1655 'trampolines', or 'aliases'.",
1659 })).unwrap_or(Ok(()))
1661 ($key_name:ident, RelocModel) => ( {
1662 let name = (stringify!($key_name)).replace("_", "-");
1663 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1664 match s.parse::<RelocModel>() {
1665 Ok(relocation_model) => base.$key_name = relocation_model,
1666 _ => return Some(Err(format!("'{}' is not a valid relocation model. \
1667 Run `rustc --print relocation-models` to \
1668 see the list of supported values.", s))),
1671 })).unwrap_or(Ok(()))
1673 ($key_name:ident, CodeModel) => ( {
1674 let name = (stringify!($key_name)).replace("_", "-");
1675 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1676 match s.parse::<CodeModel>() {
1677 Ok(code_model) => base.$key_name = Some(code_model),
1678 _ => return Some(Err(format!("'{}' is not a valid code model. \
1679 Run `rustc --print code-models` to \
1680 see the list of supported values.", s))),
1683 })).unwrap_or(Ok(()))
1685 ($key_name:ident, TlsModel) => ( {
1686 let name = (stringify!($key_name)).replace("_", "-");
1687 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1688 match s.parse::<TlsModel>() {
1689 Ok(tls_model) => base.$key_name = tls_model,
1690 _ => return Some(Err(format!("'{}' is not a valid TLS model. \
1691 Run `rustc --print tls-models` to \
1692 see the list of supported values.", s))),
1695 })).unwrap_or(Ok(()))
1697 ($key_name:ident, PanicStrategy) => ( {
1698 let name = (stringify!($key_name)).replace("_", "-");
1699 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1701 "unwind" => base.$key_name = PanicStrategy::Unwind,
1702 "abort" => base.$key_name = PanicStrategy::Abort,
1703 _ => return Some(Err(format!("'{}' is not a valid value for \
1704 panic-strategy. Use 'unwind' or 'abort'.",
1708 })).unwrap_or(Ok(()))
1710 ($key_name:ident, RelroLevel) => ( {
1711 let name = (stringify!($key_name)).replace("_", "-");
1712 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1713 match s.parse::<RelroLevel>() {
1714 Ok(level) => base.$key_name = level,
1715 _ => return Some(Err(format!("'{}' is not a valid value for \
1716 relro-level. Use 'full', 'partial, or 'off'.",
1720 })).unwrap_or(Ok(()))
1722 ($key_name:ident, SplitDebuginfo) => ( {
1723 let name = (stringify!($key_name)).replace("_", "-");
1724 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1725 match s.parse::<SplitDebuginfo>() {
1726 Ok(level) => base.$key_name = level,
1727 _ => return Some(Err(format!("'{}' is not a valid value for \
1728 split-debuginfo. Use 'off' or 'dsymutil'.",
1732 })).unwrap_or(Ok(()))
1734 ($key_name:ident, list) => ( {
1735 let name = (stringify!($key_name)).replace("_", "-");
1736 if let Some(j) = obj.remove_key(&name){
1737 if let Some(v) = Json::as_array(&j) {
1738 base.$key_name = v.iter()
1739 .map(|a| a.as_string().unwrap().to_string())
1742 incorrect_type.push(name)
1746 ($key_name:ident, opt_list) => ( {
1747 let name = (stringify!($key_name)).replace("_", "-");
1748 if let Some(j) = obj.remove_key(&name) {
1749 if let Some(v) = Json::as_array(&j) {
1750 base.$key_name = Some(v.iter()
1751 .map(|a| a.as_string().unwrap().to_string())
1754 incorrect_type.push(name)
1758 ($key_name:ident, optional) => ( {
1759 let name = (stringify!($key_name)).replace("_", "-");
1760 if let Some(o) = obj.remove_key(&name[..]) {
1763 .map(|s| s.to_string() );
1766 ($key_name:ident, LldFlavor) => ( {
1767 let name = (stringify!($key_name)).replace("_", "-");
1768 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1769 if let Some(flavor) = LldFlavor::from_str(&s) {
1770 base.$key_name = flavor;
1772 return Some(Err(format!(
1773 "'{}' is not a valid value for lld-flavor. \
1774 Use 'darwin', 'gnu', 'link' or 'wasm.",
1778 })).unwrap_or(Ok(()))
1780 ($key_name:ident, LinkerFlavor) => ( {
1781 let name = (stringify!($key_name)).replace("_", "-");
1782 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1783 match LinkerFlavor::from_str(s) {
1784 Some(linker_flavor) => base.$key_name = linker_flavor,
1785 _ => return Some(Err(format!("'{}' is not a valid value for linker-flavor. \
1786 Use {}", s, LinkerFlavor::one_of()))),
1789 })).unwrap_or(Ok(()))
1791 ($key_name:ident, StackProbeType) => ( {
1792 let name = (stringify!($key_name)).replace("_", "-");
1793 obj.remove_key(&name[..]).and_then(|o| match StackProbeType::from_json(&o) {
1799 format!("`{:?}` is not a valid value for `{}`: {}", o, name, s)
1801 }).unwrap_or(Ok(()))
1803 ($key_name:ident, SanitizerSet) => ( {
1804 let name = (stringify!($key_name)).replace("_", "-");
1805 if let Some(o) = obj.remove_key(&name[..]) {
1806 if let Some(a) = o.as_array() {
1808 base.$key_name |= match s.as_string() {
1809 Some("address") => SanitizerSet::ADDRESS,
1810 Some("cfi") => SanitizerSet::CFI,
1811 Some("leak") => SanitizerSet::LEAK,
1812 Some("memory") => SanitizerSet::MEMORY,
1813 Some("thread") => SanitizerSet::THREAD,
1814 Some("hwaddress") => SanitizerSet::HWADDRESS,
1815 Some(s) => return Err(format!("unknown sanitizer {}", s)),
1816 _ => return Err(format!("not a string: {:?}", s)),
1820 incorrect_type.push(name)
1823 Ok::<(), String>(())
1826 ($key_name:ident, crt_objects_fallback) => ( {
1827 let name = (stringify!($key_name)).replace("_", "-");
1828 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1829 match s.parse::<CrtObjectsFallback>() {
1830 Ok(fallback) => base.$key_name = Some(fallback),
1831 _ => return Some(Err(format!("'{}' is not a valid CRT objects fallback. \
1832 Use 'musl', 'mingw' or 'wasm'", s))),
1835 })).unwrap_or(Ok(()))
1837 ($key_name:ident, link_objects) => ( {
1838 let name = (stringify!($key_name)).replace("_", "-");
1839 if let Some(val) = obj.remove_key(&name[..]) {
1840 let obj = val.as_object().ok_or_else(|| format!("{}: expected a \
1841 JSON object with fields per CRT object kind.", name))?;
1842 let mut args = CrtObjects::new();
1844 let kind = LinkOutputKind::from_str(&k).ok_or_else(|| {
1845 format!("{}: '{}' is not a valid value for CRT object kind. \
1846 Use '(dynamic,static)-(nopic,pic)-exe' or \
1847 '(dynamic,static)-dylib' or 'wasi-reactor-exe'", name, k)
1850 let v = v.as_array().ok_or_else(||
1851 format!("{}.{}: expected a JSON array", name, k)
1852 )?.iter().enumerate()
1854 let s = s.as_string().ok_or_else(||
1855 format!("{}.{}[{}]: expected a JSON string", name, k, i))?;
1858 .collect::<Result<Vec<_>, String>>()?;
1860 args.insert(kind, v);
1862 base.$key_name = args;
1865 ($key_name:ident, link_args) => ( {
1866 let name = (stringify!($key_name)).replace("_", "-");
1867 if let Some(val) = obj.remove_key(&name[..]) {
1868 let obj = val.as_object().ok_or_else(|| format!("{}: expected a \
1869 JSON object with fields per linker-flavor.", name))?;
1870 let mut args = LinkArgs::new();
1872 let flavor = LinkerFlavor::from_str(&k).ok_or_else(|| {
1873 format!("{}: '{}' is not a valid value for linker-flavor. \
1874 Use 'em', 'gcc', 'ld' or 'msvc'", name, k)
1877 let v = v.as_array().ok_or_else(||
1878 format!("{}.{}: expected a JSON array", name, k)
1879 )?.iter().enumerate()
1881 let s = s.as_string().ok_or_else(||
1882 format!("{}.{}[{}]: expected a JSON string", name, k, i))?;
1885 .collect::<Result<Vec<_>, String>>()?;
1887 args.insert(flavor, v);
1889 base.$key_name = args;
1892 ($key_name:ident, env) => ( {
1893 let name = (stringify!($key_name)).replace("_", "-");
1894 if let Some(o) = obj.remove_key(&name[..]) {
1895 if let Some(a) = o.as_array() {
1897 if let Some(s) = o.as_string() {
1898 let p = s.split('=').collect::<Vec<_>>();
1900 let k = p[0].to_string();
1901 let v = p[1].to_string();
1902 base.$key_name.push((k, v));
1907 incorrect_type.push(name)
1911 ($key_name:ident, Option<Abi>) => ( {
1912 let name = (stringify!($key_name)).replace("_", "-");
1913 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1914 match lookup_abi(s) {
1915 Some(abi) => base.$key_name = Some(abi),
1916 _ => return Some(Err(format!("'{}' is not a valid value for abi", s))),
1919 })).unwrap_or(Ok(()))
1921 ($key_name:ident, TargetFamilies) => ( {
1922 if let Some(value) = obj.remove_key("target-family") {
1923 if let Some(v) = Json::as_array(&value) {
1924 base.$key_name = v.iter()
1925 .map(|a| a.as_string().unwrap().to_string())
1927 } else if let Some(v) = Json::as_string(&value) {
1928 base.$key_name = vec![v.to_string()];
1934 if let Some(j) = obj.remove_key("target-endian") {
1935 if let Some(s) = Json::as_string(&j) {
1936 base.endian = s.parse()?;
1938 incorrect_type.push("target-endian".to_string())
1942 if let Some(fp) = obj.remove_key("frame-pointer") {
1943 if let Some(s) = Json::as_string(&fp) {
1944 base.frame_pointer = s
1946 .map_err(|()| format!("'{}' is not a valid value for frame-pointer", s))?;
1948 incorrect_type.push("frame-pointer".to_string())
1952 key!(is_builtin, bool);
1953 key!(c_int_width = "target-c-int-width");
1958 key!(linker_flavor, LinkerFlavor)?;
1959 key!(linker, optional);
1960 key!(lld_flavor, LldFlavor)?;
1961 key!(pre_link_objects, link_objects);
1962 key!(post_link_objects, link_objects);
1963 key!(pre_link_objects_fallback, link_objects);
1964 key!(post_link_objects_fallback, link_objects);
1965 key!(crt_objects_fallback, crt_objects_fallback)?;
1966 key!(pre_link_args, link_args);
1967 key!(late_link_args, link_args);
1968 key!(late_link_args_dynamic, link_args);
1969 key!(late_link_args_static, link_args);
1970 key!(post_link_args, link_args);
1971 key!(link_script, optional);
1972 key!(link_env, env);
1973 key!(link_env_remove, list);
1974 key!(asm_args, list);
1977 key!(dynamic_linking, bool);
1978 key!(only_cdylib, bool);
1979 key!(executables, bool);
1980 key!(relocation_model, RelocModel)?;
1981 key!(code_model, CodeModel)?;
1982 key!(tls_model, TlsModel)?;
1983 key!(disable_redzone, bool);
1984 key!(function_sections, bool);
1988 key!(staticlib_prefix);
1989 key!(staticlib_suffix);
1990 key!(families, TargetFamilies);
1991 key!(abi_return_struct_as_int, bool);
1992 key!(is_like_osx, bool);
1993 key!(is_like_solaris, bool);
1994 key!(is_like_windows, bool);
1995 key!(is_like_msvc, bool);
1996 key!(is_like_emscripten, bool);
1997 key!(is_like_fuchsia, bool);
1998 key!(is_like_wasm, bool);
1999 key!(dwarf_version, Option<u32>);
2000 key!(linker_is_gnu, bool);
2001 key!(allows_weak_linkage, bool);
2002 key!(has_rpath, bool);
2003 key!(no_default_libraries, bool);
2004 key!(position_independent_executables, bool);
2005 key!(static_position_independent_executables, bool);
2006 key!(needs_plt, bool);
2007 key!(relro_level, RelroLevel)?;
2008 key!(archive_format);
2009 key!(allow_asm, bool);
2010 key!(main_needs_argc_argv, bool);
2011 key!(has_elf_tls, bool);
2012 key!(obj_is_bitcode, bool);
2013 key!(forces_embed_bitcode, bool);
2014 key!(bitcode_llvm_cmdline);
2015 key!(max_atomic_width, Option<u64>);
2016 key!(min_atomic_width, Option<u64>);
2017 key!(atomic_cas, bool);
2018 key!(panic_strategy, PanicStrategy)?;
2019 key!(crt_static_allows_dylibs, bool);
2020 key!(crt_static_default, bool);
2021 key!(crt_static_respected, bool);
2022 key!(stack_probes, StackProbeType)?;
2023 key!(min_global_align, Option<u64>);
2024 key!(default_codegen_units, Option<u64>);
2025 key!(trap_unreachable, bool);
2026 key!(requires_lto, bool);
2027 key!(singlethread, bool);
2028 key!(no_builtins, bool);
2029 key!(default_hidden_visibility, bool);
2030 key!(emit_debug_gdb_scripts, bool);
2031 key!(requires_uwtable, bool);
2032 key!(default_uwtable, bool);
2033 key!(simd_types_indirect, bool);
2034 key!(limit_rdylib_exports, bool);
2035 key!(override_export_symbols, opt_list);
2036 key!(merge_functions, MergeFunctions)?;
2037 key!(mcount = "target-mcount");
2039 key!(relax_elf_relocations, bool);
2040 key!(llvm_args, list);
2041 key!(use_ctors_section, bool);
2042 key!(eh_frame_header, bool);
2043 key!(has_thumb_interworking, bool);
2044 key!(split_debuginfo, SplitDebuginfo)?;
2045 key!(supported_sanitizers, SanitizerSet)?;
2046 key!(default_adjusted_cabi, Option<Abi>)?;
2047 key!(c_enum_min_bits, u64);
2049 if base.is_builtin {
2050 // This can cause unfortunate ICEs later down the line.
2051 return Err("may not set is_builtin for targets not built-in".to_string());
2053 // Each field should have been read using `Json::remove_key` so any keys remaining are unused.
2054 let remaining_keys = obj.as_object().ok_or("Expected JSON object for target")?.keys();
2057 TargetWarnings { unused_fields: remaining_keys.cloned().collect(), incorrect_type },
2061 /// Search for a JSON file specifying the given target triple.
2063 /// If none is found in `$RUST_TARGET_PATH`, look for a file called `target.json` inside the
2064 /// sysroot under the target-triple's `rustlib` directory. Note that it could also just be a
2065 /// bare filename already, so also check for that. If one of the hardcoded targets we know
2066 /// about, just return it directly.
2068 /// The error string could come from any of the APIs called, including filesystem access and
2071 target_triple: &TargetTriple,
2073 ) -> Result<(Target, TargetWarnings), String> {
2074 use rustc_serialize::json;
2078 fn load_file(path: &Path) -> Result<(Target, TargetWarnings), String> {
2079 let contents = fs::read(path).map_err(|e| e.to_string())?;
2080 let obj = json::from_reader(&mut &contents[..]).map_err(|e| e.to_string())?;
2081 Target::from_json(obj)
2084 match *target_triple {
2085 TargetTriple::TargetTriple(ref target_triple) => {
2086 // check if triple is in list of built-in targets
2087 if let Some(t) = load_builtin(target_triple) {
2088 return Ok((t, TargetWarnings::empty()));
2091 // search for a file named `target_triple`.json in RUST_TARGET_PATH
2093 let mut target = target_triple.to_string();
2094 target.push_str(".json");
2095 PathBuf::from(target)
2098 let target_path = env::var_os("RUST_TARGET_PATH").unwrap_or_default();
2100 for dir in env::split_paths(&target_path) {
2101 let p = dir.join(&path);
2103 return load_file(&p);
2107 // Additionally look in the sysroot under `lib/rustlib/<triple>/target.json`
2109 let rustlib_path = crate::target_rustlib_path(&sysroot, &target_triple);
2110 let p = std::array::IntoIter::new([
2112 Path::new(&rustlib_path),
2113 Path::new("target.json"),
2115 .collect::<PathBuf>();
2117 return load_file(&p);
2120 Err(format!("Could not find specification for target {:?}", target_triple))
2122 TargetTriple::TargetPath(ref target_path) => {
2123 if target_path.is_file() {
2124 return load_file(&target_path);
2126 Err(format!("Target path {:?} is not a valid file", target_path))
2132 impl ToJson for Target {
2133 fn to_json(&self) -> Json {
2134 let mut d = BTreeMap::new();
2135 let default: TargetOptions = Default::default();
2137 macro_rules! target_val {
2139 let name = (stringify!($attr)).replace("_", "-");
2140 d.insert(name, self.$attr.to_json());
2142 ($attr:ident, $key_name:expr) => {{
2143 let name = $key_name;
2144 d.insert(name.to_string(), self.$attr.to_json());
2148 macro_rules! target_option_val {
2150 let name = (stringify!($attr)).replace("_", "-");
2151 if default.$attr != self.$attr {
2152 d.insert(name, self.$attr.to_json());
2155 ($attr:ident, $key_name:expr) => {{
2156 let name = $key_name;
2157 if default.$attr != self.$attr {
2158 d.insert(name.to_string(), self.$attr.to_json());
2161 (link_args - $attr:ident) => {{
2162 let name = (stringify!($attr)).replace("_", "-");
2163 if default.$attr != self.$attr {
2167 .map(|(k, v)| (k.desc().to_owned(), v.clone()))
2168 .collect::<BTreeMap<_, _>>();
2169 d.insert(name, obj.to_json());
2172 (env - $attr:ident) => {{
2173 let name = (stringify!($attr)).replace("_", "-");
2174 if default.$attr != self.$attr {
2178 .map(|&(ref k, ref v)| k.clone() + "=" + &v)
2179 .collect::<Vec<_>>();
2180 d.insert(name, obj.to_json());
2185 target_val!(llvm_target);
2186 d.insert("target-pointer-width".to_string(), self.pointer_width.to_string().to_json());
2188 target_val!(data_layout);
2190 target_option_val!(is_builtin);
2191 target_option_val!(endian, "target-endian");
2192 target_option_val!(c_int_width, "target-c-int-width");
2193 target_option_val!(os);
2194 target_option_val!(env);
2195 target_option_val!(abi);
2196 target_option_val!(vendor);
2197 target_option_val!(linker_flavor);
2198 target_option_val!(linker);
2199 target_option_val!(lld_flavor);
2200 target_option_val!(pre_link_objects);
2201 target_option_val!(post_link_objects);
2202 target_option_val!(pre_link_objects_fallback);
2203 target_option_val!(post_link_objects_fallback);
2204 target_option_val!(crt_objects_fallback);
2205 target_option_val!(link_args - pre_link_args);
2206 target_option_val!(link_args - late_link_args);
2207 target_option_val!(link_args - late_link_args_dynamic);
2208 target_option_val!(link_args - late_link_args_static);
2209 target_option_val!(link_args - post_link_args);
2210 target_option_val!(link_script);
2211 target_option_val!(env - link_env);
2212 target_option_val!(link_env_remove);
2213 target_option_val!(asm_args);
2214 target_option_val!(cpu);
2215 target_option_val!(features);
2216 target_option_val!(dynamic_linking);
2217 target_option_val!(only_cdylib);
2218 target_option_val!(executables);
2219 target_option_val!(relocation_model);
2220 target_option_val!(code_model);
2221 target_option_val!(tls_model);
2222 target_option_val!(disable_redzone);
2223 target_option_val!(frame_pointer);
2224 target_option_val!(function_sections);
2225 target_option_val!(dll_prefix);
2226 target_option_val!(dll_suffix);
2227 target_option_val!(exe_suffix);
2228 target_option_val!(staticlib_prefix);
2229 target_option_val!(staticlib_suffix);
2230 target_option_val!(families, "target-family");
2231 target_option_val!(abi_return_struct_as_int);
2232 target_option_val!(is_like_osx);
2233 target_option_val!(is_like_solaris);
2234 target_option_val!(is_like_windows);
2235 target_option_val!(is_like_msvc);
2236 target_option_val!(is_like_emscripten);
2237 target_option_val!(is_like_fuchsia);
2238 target_option_val!(is_like_wasm);
2239 target_option_val!(dwarf_version);
2240 target_option_val!(linker_is_gnu);
2241 target_option_val!(allows_weak_linkage);
2242 target_option_val!(has_rpath);
2243 target_option_val!(no_default_libraries);
2244 target_option_val!(position_independent_executables);
2245 target_option_val!(static_position_independent_executables);
2246 target_option_val!(needs_plt);
2247 target_option_val!(relro_level);
2248 target_option_val!(archive_format);
2249 target_option_val!(allow_asm);
2250 target_option_val!(main_needs_argc_argv);
2251 target_option_val!(has_elf_tls);
2252 target_option_val!(obj_is_bitcode);
2253 target_option_val!(forces_embed_bitcode);
2254 target_option_val!(bitcode_llvm_cmdline);
2255 target_option_val!(min_atomic_width);
2256 target_option_val!(max_atomic_width);
2257 target_option_val!(atomic_cas);
2258 target_option_val!(panic_strategy);
2259 target_option_val!(crt_static_allows_dylibs);
2260 target_option_val!(crt_static_default);
2261 target_option_val!(crt_static_respected);
2262 target_option_val!(stack_probes);
2263 target_option_val!(min_global_align);
2264 target_option_val!(default_codegen_units);
2265 target_option_val!(trap_unreachable);
2266 target_option_val!(requires_lto);
2267 target_option_val!(singlethread);
2268 target_option_val!(no_builtins);
2269 target_option_val!(default_hidden_visibility);
2270 target_option_val!(emit_debug_gdb_scripts);
2271 target_option_val!(requires_uwtable);
2272 target_option_val!(default_uwtable);
2273 target_option_val!(simd_types_indirect);
2274 target_option_val!(limit_rdylib_exports);
2275 target_option_val!(override_export_symbols);
2276 target_option_val!(merge_functions);
2277 target_option_val!(mcount, "target-mcount");
2278 target_option_val!(llvm_abiname);
2279 target_option_val!(relax_elf_relocations);
2280 target_option_val!(llvm_args);
2281 target_option_val!(use_ctors_section);
2282 target_option_val!(eh_frame_header);
2283 target_option_val!(has_thumb_interworking);
2284 target_option_val!(split_debuginfo);
2285 target_option_val!(supported_sanitizers);
2286 target_option_val!(c_enum_min_bits);
2288 if let Some(abi) = self.default_adjusted_cabi {
2289 d.insert("default-adjusted-cabi".to_string(), Abi::name(abi).to_json());
2296 /// Either a target triple string or a path to a JSON file.
2297 #[derive(PartialEq, Clone, Debug, Hash, Encodable, Decodable)]
2298 pub enum TargetTriple {
2299 TargetTriple(String),
2300 TargetPath(PathBuf),
2304 /// Creates a target triple from the passed target triple string.
2305 pub fn from_triple(triple: &str) -> Self {
2306 TargetTriple::TargetTriple(triple.to_string())
2309 /// Creates a target triple from the passed target path.
2310 pub fn from_path(path: &Path) -> Result<Self, io::Error> {
2311 let canonicalized_path = path.canonicalize()?;
2312 Ok(TargetTriple::TargetPath(canonicalized_path))
2315 /// Returns a string triple for this target.
2317 /// If this target is a path, the file name (without extension) is returned.
2318 pub fn triple(&self) -> &str {
2320 TargetTriple::TargetTriple(ref triple) => triple,
2321 TargetTriple::TargetPath(ref path) => path
2323 .expect("target path must not be empty")
2325 .expect("target path must be valid unicode"),
2329 /// Returns an extended string triple for this target.
2331 /// If this target is a path, a hash of the path is appended to the triple returned
2333 pub fn debug_triple(&self) -> String {
2334 use std::collections::hash_map::DefaultHasher;
2335 use std::hash::{Hash, Hasher};
2337 let triple = self.triple();
2338 if let TargetTriple::TargetPath(ref path) = *self {
2339 let mut hasher = DefaultHasher::new();
2340 path.hash(&mut hasher);
2341 let hash = hasher.finish();
2342 format!("{}-{}", triple, hash)
2349 impl fmt::Display for TargetTriple {
2350 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2351 write!(f, "{}", self.debug_triple())