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::json::{Json, ToJson};
39 use crate::spec::abi::{lookup as lookup_abi, Abi};
40 use crate::spec::crt_objects::{CrtObjects, LinkSelfContainedDefault};
41 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
42 use rustc_serialize::{Decodable, Decoder, Encodable, Encoder};
43 use rustc_span::symbol::{sym, Symbol};
44 use serde_json::Value;
46 use std::collections::BTreeMap;
47 use std::convert::TryFrom;
48 use std::hash::{Hash, Hasher};
49 use std::iter::FromIterator;
50 use std::ops::{Deref, DerefMut};
51 use std::path::{Path, PathBuf};
52 use std::str::FromStr;
55 use rustc_macros::HashStable_Generic;
74 mod linux_kernel_base;
76 mod linux_uclibc_base;
88 mod windows_gnullvm_base;
89 mod windows_msvc_base;
90 mod windows_uwp_gnu_base;
91 mod windows_uwp_msvc_base;
93 /// Linker is called through a C/C++ compiler.
94 #[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
101 #[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
107 /// All linkers have some kinds of command line interfaces and rustc needs to know which commands
108 /// to use with each of them. So we cluster all such interfaces into a (somewhat arbitrary) number
109 /// of classes that we call "linker flavors".
111 /// Technically, it's not even necessary, we can nearly always infer the flavor from linker name
112 /// and target properties like `is_like_windows`/`is_like_osx`/etc. However, the PRs originally
113 /// introducing `-Clinker-flavor` (#40018 and friends) were aiming to reduce this kind of inference
114 /// and provide something certain and explicitly specified instead, and that design goal is still
117 /// The second goal is to keep the number of flavors to the minimum if possible.
118 /// LLD somewhat forces our hand here because that linker is self-sufficent only if its executable
119 /// (`argv[0]`) is named in specific way, otherwise it doesn't work and requires a
120 /// `-flavor LLD_FLAVOR` argument to choose which logic to use. Our shipped `rust-lld` in
121 /// particular is not named in such specific way, so it needs the flavor option, so we make our
122 /// linker flavors sufficiently fine-grained to satisfy LLD without inferring its flavor from other
123 /// target properties, in accordance with the first design goal.
125 /// The first component of the flavor is tightly coupled with the compilation target,
126 /// while the `Cc` and `Lld` flags can vary withing the same target.
127 #[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
128 pub enum LinkerFlavor {
129 /// Unix-like linker with GNU extensions (both naked and compiler-wrapped forms).
130 /// Besides similar "default" Linux/BSD linkers this also includes Windows/GNU linker,
131 /// which is somewhat different because it doesn't produce ELFs.
133 /// Unix-like linker for Apple targets (both naked and compiler-wrapped forms).
134 /// Extracted from the "umbrella" `Unix` flavor due to its corresponding LLD flavor.
136 /// Unix-like linker for Wasm targets (both naked and compiler-wrapped forms).
137 /// Extracted from the "umbrella" `Unix` flavor due to its corresponding LLD flavor.
138 /// Non-LLD version does not exist, so the lld flag is currently hardcoded here.
140 /// Basic Unix-like linker for "any other Unix" targets (Solaris/illumos, L4Re, MSP430, etc),
141 /// possibly with non-GNU extensions (both naked and compiler-wrapped forms).
142 /// LLD doesn't support any of these.
144 /// MSVC-style linker for Windows and UEFI, LLD supports it.
146 /// Emscripten Compiler Frontend, a wrapper around `WasmLld(Cc::Yes)` that has a different
147 /// interface and produces some additional JavaScript output.
149 // Below: other linker-like tools with unique interfaces for exotic targets.
150 /// Linker tool for BPF.
152 /// Linker tool for Nvidia PTX.
156 /// Linker flavors available externally through command line (`-Clinker-flavor`)
157 /// or json target specifications.
158 /// FIXME: This set has accumulated historically, bring it more in line with the internal
159 /// linker flavors (`LinkerFlavor`).
160 #[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
161 pub enum LinkerFlavorCli {
171 #[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
180 pub fn as_str(&self) -> &'static str {
182 LldFlavor::Wasm => "wasm",
183 LldFlavor::Ld64 => "darwin",
184 LldFlavor::Ld => "gnu",
185 LldFlavor::Link => "link",
189 fn from_str(s: &str) -> Option<Self> {
191 "darwin" => LldFlavor::Ld64,
192 "gnu" => LldFlavor::Ld,
193 "link" => LldFlavor::Link,
194 "wasm" => LldFlavor::Wasm,
200 impl ToJson for LldFlavor {
201 fn to_json(&self) -> Json {
202 self.as_str().to_json()
207 pub fn from_cli(cli: LinkerFlavorCli, target: &TargetOptions) -> LinkerFlavor {
208 Self::from_cli_impl(cli, target.linker_flavor.lld_flavor(), target.linker_flavor.is_gnu())
211 /// The passed CLI flavor is preferred over other args coming from the default target spec,
212 /// so this function can produce a flavor that is incompatible with the current target.
213 /// FIXME: Produce errors when `-Clinker-flavor` is set to something incompatible
214 /// with the current target.
215 fn from_cli_impl(cli: LinkerFlavorCli, lld_flavor: LldFlavor, is_gnu: bool) -> LinkerFlavor {
217 LinkerFlavorCli::Gcc => match lld_flavor {
218 LldFlavor::Ld if is_gnu => LinkerFlavor::Gnu(Cc::Yes, Lld::No),
219 LldFlavor::Ld64 => LinkerFlavor::Darwin(Cc::Yes, Lld::No),
220 LldFlavor::Wasm => LinkerFlavor::WasmLld(Cc::Yes),
221 LldFlavor::Ld | LldFlavor::Link => LinkerFlavor::Unix(Cc::Yes),
223 LinkerFlavorCli::Ld => match lld_flavor {
224 LldFlavor::Ld if is_gnu => LinkerFlavor::Gnu(Cc::No, Lld::No),
225 LldFlavor::Ld64 => LinkerFlavor::Darwin(Cc::No, Lld::No),
226 LldFlavor::Ld | LldFlavor::Wasm | LldFlavor::Link => LinkerFlavor::Unix(Cc::No),
228 LinkerFlavorCli::Lld(LldFlavor::Ld) => LinkerFlavor::Gnu(Cc::No, Lld::Yes),
229 LinkerFlavorCli::Lld(LldFlavor::Ld64) => LinkerFlavor::Darwin(Cc::No, Lld::Yes),
230 LinkerFlavorCli::Lld(LldFlavor::Wasm) => LinkerFlavor::WasmLld(Cc::No),
231 LinkerFlavorCli::Lld(LldFlavor::Link) => LinkerFlavor::Msvc(Lld::Yes),
232 LinkerFlavorCli::Msvc => LinkerFlavor::Msvc(Lld::No),
233 LinkerFlavorCli::Em => LinkerFlavor::EmCc,
234 LinkerFlavorCli::BpfLinker => LinkerFlavor::Bpf,
235 LinkerFlavorCli::PtxLinker => LinkerFlavor::Ptx,
239 fn to_cli(self) -> LinkerFlavorCli {
241 LinkerFlavor::Gnu(Cc::Yes, _)
242 | LinkerFlavor::Darwin(Cc::Yes, _)
243 | LinkerFlavor::WasmLld(Cc::Yes)
244 | LinkerFlavor::Unix(Cc::Yes) => LinkerFlavorCli::Gcc,
245 LinkerFlavor::Gnu(_, Lld::Yes) => LinkerFlavorCli::Lld(LldFlavor::Ld),
246 LinkerFlavor::Darwin(_, Lld::Yes) => LinkerFlavorCli::Lld(LldFlavor::Ld64),
247 LinkerFlavor::WasmLld(..) => LinkerFlavorCli::Lld(LldFlavor::Wasm),
248 LinkerFlavor::Gnu(..) | LinkerFlavor::Darwin(..) | LinkerFlavor::Unix(..) => {
251 LinkerFlavor::Msvc(Lld::Yes) => LinkerFlavorCli::Lld(LldFlavor::Link),
252 LinkerFlavor::Msvc(..) => LinkerFlavorCli::Msvc,
253 LinkerFlavor::EmCc => LinkerFlavorCli::Em,
254 LinkerFlavor::Bpf => LinkerFlavorCli::BpfLinker,
255 LinkerFlavor::Ptx => LinkerFlavorCli::PtxLinker,
259 pub fn lld_flavor(self) -> LldFlavor {
261 LinkerFlavor::Gnu(..)
262 | LinkerFlavor::Unix(..)
265 | LinkerFlavor::Ptx => LldFlavor::Ld,
266 LinkerFlavor::Darwin(..) => LldFlavor::Ld64,
267 LinkerFlavor::WasmLld(..) => LldFlavor::Wasm,
268 LinkerFlavor::Msvc(..) => LldFlavor::Link,
272 pub fn is_gnu(self) -> bool {
273 matches!(self, LinkerFlavor::Gnu(..))
277 macro_rules! linker_flavor_cli_impls {
278 ($(($($flavor:tt)*) $string:literal)*) => (
279 impl LinkerFlavorCli {
280 pub const fn one_of() -> &'static str {
281 concat!("one of: ", $($string, " ",)*)
284 pub fn from_str(s: &str) -> Option<LinkerFlavorCli> {
286 $($string => $($flavor)*,)*
291 pub fn desc(&self) -> &str {
293 $($($flavor)* => $string,)*
300 linker_flavor_cli_impls! {
301 (LinkerFlavorCli::Gcc) "gcc"
302 (LinkerFlavorCli::Ld) "ld"
303 (LinkerFlavorCli::Lld(LldFlavor::Ld)) "ld.lld"
304 (LinkerFlavorCli::Lld(LldFlavor::Ld64)) "ld64.lld"
305 (LinkerFlavorCli::Lld(LldFlavor::Link)) "lld-link"
306 (LinkerFlavorCli::Lld(LldFlavor::Wasm)) "wasm-ld"
307 (LinkerFlavorCli::Msvc) "msvc"
308 (LinkerFlavorCli::Em) "em"
309 (LinkerFlavorCli::BpfLinker) "bpf-linker"
310 (LinkerFlavorCli::PtxLinker) "ptx-linker"
313 impl ToJson for LinkerFlavorCli {
314 fn to_json(&self) -> Json {
315 self.desc().to_json()
319 #[derive(Clone, Copy, Debug, PartialEq, Hash, Encodable, Decodable, HashStable_Generic)]
320 pub enum PanicStrategy {
326 pub fn desc(&self) -> &str {
328 PanicStrategy::Unwind => "unwind",
329 PanicStrategy::Abort => "abort",
333 pub const fn desc_symbol(&self) -> Symbol {
335 PanicStrategy::Unwind => sym::unwind,
336 PanicStrategy::Abort => sym::abort,
340 pub const fn all() -> [Symbol; 2] {
341 [Self::Abort.desc_symbol(), Self::Unwind.desc_symbol()]
345 impl ToJson for PanicStrategy {
346 fn to_json(&self) -> Json {
348 PanicStrategy::Abort => "abort".to_json(),
349 PanicStrategy::Unwind => "unwind".to_json(),
354 #[derive(Clone, Copy, Debug, PartialEq, Hash)]
355 pub enum RelroLevel {
363 pub fn desc(&self) -> &str {
365 RelroLevel::Full => "full",
366 RelroLevel::Partial => "partial",
367 RelroLevel::Off => "off",
368 RelroLevel::None => "none",
373 impl FromStr for RelroLevel {
376 fn from_str(s: &str) -> Result<RelroLevel, ()> {
378 "full" => Ok(RelroLevel::Full),
379 "partial" => Ok(RelroLevel::Partial),
380 "off" => Ok(RelroLevel::Off),
381 "none" => Ok(RelroLevel::None),
387 impl ToJson for RelroLevel {
388 fn to_json(&self) -> Json {
390 RelroLevel::Full => "full".to_json(),
391 RelroLevel::Partial => "partial".to_json(),
392 RelroLevel::Off => "off".to_json(),
393 RelroLevel::None => "None".to_json(),
398 #[derive(Clone, Copy, Debug, PartialEq, Hash)]
399 pub enum MergeFunctions {
405 impl MergeFunctions {
406 pub fn desc(&self) -> &str {
408 MergeFunctions::Disabled => "disabled",
409 MergeFunctions::Trampolines => "trampolines",
410 MergeFunctions::Aliases => "aliases",
415 impl FromStr for MergeFunctions {
418 fn from_str(s: &str) -> Result<MergeFunctions, ()> {
420 "disabled" => Ok(MergeFunctions::Disabled),
421 "trampolines" => Ok(MergeFunctions::Trampolines),
422 "aliases" => Ok(MergeFunctions::Aliases),
428 impl ToJson for MergeFunctions {
429 fn to_json(&self) -> Json {
431 MergeFunctions::Disabled => "disabled".to_json(),
432 MergeFunctions::Trampolines => "trampolines".to_json(),
433 MergeFunctions::Aliases => "aliases".to_json(),
438 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
439 pub enum RelocModel {
449 impl FromStr for RelocModel {
452 fn from_str(s: &str) -> Result<RelocModel, ()> {
454 "static" => RelocModel::Static,
455 "pic" => RelocModel::Pic,
456 "pie" => RelocModel::Pie,
457 "dynamic-no-pic" => RelocModel::DynamicNoPic,
458 "ropi" => RelocModel::Ropi,
459 "rwpi" => RelocModel::Rwpi,
460 "ropi-rwpi" => RelocModel::RopiRwpi,
466 impl ToJson for RelocModel {
467 fn to_json(&self) -> Json {
469 RelocModel::Static => "static",
470 RelocModel::Pic => "pic",
471 RelocModel::Pie => "pie",
472 RelocModel::DynamicNoPic => "dynamic-no-pic",
473 RelocModel::Ropi => "ropi",
474 RelocModel::Rwpi => "rwpi",
475 RelocModel::RopiRwpi => "ropi-rwpi",
481 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
490 impl FromStr for CodeModel {
493 fn from_str(s: &str) -> Result<CodeModel, ()> {
495 "tiny" => CodeModel::Tiny,
496 "small" => CodeModel::Small,
497 "kernel" => CodeModel::Kernel,
498 "medium" => CodeModel::Medium,
499 "large" => CodeModel::Large,
505 impl ToJson for CodeModel {
506 fn to_json(&self) -> Json {
508 CodeModel::Tiny => "tiny",
509 CodeModel::Small => "small",
510 CodeModel::Kernel => "kernel",
511 CodeModel::Medium => "medium",
512 CodeModel::Large => "large",
518 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
526 impl FromStr for TlsModel {
529 fn from_str(s: &str) -> Result<TlsModel, ()> {
531 // Note the difference "general" vs "global" difference. The model name is "general",
532 // but the user-facing option name is "global" for consistency with other compilers.
533 "global-dynamic" => TlsModel::GeneralDynamic,
534 "local-dynamic" => TlsModel::LocalDynamic,
535 "initial-exec" => TlsModel::InitialExec,
536 "local-exec" => TlsModel::LocalExec,
542 impl ToJson for TlsModel {
543 fn to_json(&self) -> Json {
545 TlsModel::GeneralDynamic => "global-dynamic",
546 TlsModel::LocalDynamic => "local-dynamic",
547 TlsModel::InitialExec => "initial-exec",
548 TlsModel::LocalExec => "local-exec",
554 /// Everything is flattened to a single enum to make the json encoding/decoding less annoying.
555 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug)]
556 pub enum LinkOutputKind {
557 /// Dynamically linked non position-independent executable.
559 /// Dynamically linked position-independent executable.
561 /// Statically linked non position-independent executable.
563 /// Statically linked position-independent executable.
565 /// Regular dynamic library ("dynamically linked").
567 /// Dynamic library with bundled libc ("statically linked").
569 /// WASI module with a lifetime past the _initialize entry point
573 impl LinkOutputKind {
574 fn as_str(&self) -> &'static str {
576 LinkOutputKind::DynamicNoPicExe => "dynamic-nopic-exe",
577 LinkOutputKind::DynamicPicExe => "dynamic-pic-exe",
578 LinkOutputKind::StaticNoPicExe => "static-nopic-exe",
579 LinkOutputKind::StaticPicExe => "static-pic-exe",
580 LinkOutputKind::DynamicDylib => "dynamic-dylib",
581 LinkOutputKind::StaticDylib => "static-dylib",
582 LinkOutputKind::WasiReactorExe => "wasi-reactor-exe",
586 pub(super) fn from_str(s: &str) -> Option<LinkOutputKind> {
588 "dynamic-nopic-exe" => LinkOutputKind::DynamicNoPicExe,
589 "dynamic-pic-exe" => LinkOutputKind::DynamicPicExe,
590 "static-nopic-exe" => LinkOutputKind::StaticNoPicExe,
591 "static-pic-exe" => LinkOutputKind::StaticPicExe,
592 "dynamic-dylib" => LinkOutputKind::DynamicDylib,
593 "static-dylib" => LinkOutputKind::StaticDylib,
594 "wasi-reactor-exe" => LinkOutputKind::WasiReactorExe,
600 impl fmt::Display for LinkOutputKind {
601 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
602 f.write_str(self.as_str())
606 pub type LinkArgs = BTreeMap<LinkerFlavor, Vec<StaticCow<str>>>;
607 pub type LinkArgsCli = BTreeMap<LinkerFlavorCli, Vec<StaticCow<str>>>;
609 /// Which kind of debuginfo does the target use?
611 /// Useful in determining whether a target supports Split DWARF (a target with
612 /// `DebuginfoKind::Dwarf` and supporting `SplitDebuginfo::Unpacked` for example).
613 #[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq)]
614 pub enum DebuginfoKind {
615 /// DWARF debuginfo (such as that used on `x86_64_unknown_linux_gnu`).
618 /// DWARF debuginfo in dSYM files (such as on Apple platforms).
620 /// Program database files (such as on Windows).
625 fn as_str(&self) -> &'static str {
627 DebuginfoKind::Dwarf => "dwarf",
628 DebuginfoKind::DwarfDsym => "dwarf-dsym",
629 DebuginfoKind::Pdb => "pdb",
634 impl FromStr for DebuginfoKind {
637 fn from_str(s: &str) -> Result<Self, ()> {
639 "dwarf" => DebuginfoKind::Dwarf,
640 "dwarf-dsym" => DebuginfoKind::DwarfDsym,
641 "pdb" => DebuginfoKind::Pdb,
647 impl ToJson for DebuginfoKind {
648 fn to_json(&self) -> Json {
649 self.as_str().to_json()
653 impl fmt::Display for DebuginfoKind {
654 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
655 f.write_str(self.as_str())
659 #[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq)]
660 pub enum SplitDebuginfo {
661 /// Split debug-information is disabled, meaning that on supported platforms
662 /// you can find all debug information in the executable itself. This is
663 /// only supported for ELF effectively.
665 /// * Windows - not supported
666 /// * macOS - don't run `dsymutil`
667 /// * ELF - `.debug_*` sections
671 /// Split debug-information can be found in a "packed" location separate
672 /// from the final artifact. This is supported on all platforms.
674 /// * Windows - `*.pdb`
675 /// * macOS - `*.dSYM` (run `dsymutil`)
676 /// * ELF - `*.dwp` (run `thorin`)
679 /// Split debug-information can be found in individual object files on the
680 /// filesystem. The main executable may point to the object files.
682 /// * Windows - not supported
683 /// * macOS - supported, scattered object files
684 /// * ELF - supported, scattered `*.dwo` or `*.o` files (see `SplitDwarfKind`)
688 impl SplitDebuginfo {
689 fn as_str(&self) -> &'static str {
691 SplitDebuginfo::Off => "off",
692 SplitDebuginfo::Packed => "packed",
693 SplitDebuginfo::Unpacked => "unpacked",
698 impl FromStr for SplitDebuginfo {
701 fn from_str(s: &str) -> Result<Self, ()> {
703 "off" => SplitDebuginfo::Off,
704 "unpacked" => SplitDebuginfo::Unpacked,
705 "packed" => SplitDebuginfo::Packed,
711 impl ToJson for SplitDebuginfo {
712 fn to_json(&self) -> Json {
713 self.as_str().to_json()
717 impl fmt::Display for SplitDebuginfo {
718 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
719 f.write_str(self.as_str())
723 #[derive(Clone, Debug, PartialEq, Eq)]
724 pub enum StackProbeType {
725 /// Don't emit any stack probes.
727 /// It is harmless to use this option even on targets that do not have backend support for
728 /// stack probes as the failure mode is the same as if no stack-probe option was specified in
731 /// Call `__rust_probestack` whenever stack needs to be probed.
733 /// Use inline option for LLVM versions later than specified in `min_llvm_version_for_inline`
734 /// and call `__rust_probestack` otherwise.
735 InlineOrCall { min_llvm_version_for_inline: (u32, u32, u32) },
738 impl StackProbeType {
739 // LLVM X86 targets (ix86 and x86_64) can use inline-asm stack probes starting with LLVM 16.
740 // Notable past issues were rust#83139 (fixed in 14) and rust#84667 (fixed in 16).
741 const X86: Self = Self::InlineOrCall { min_llvm_version_for_inline: (16, 0, 0) };
743 fn from_json(json: &Json) -> Result<Self, String> {
744 let object = json.as_object().ok_or_else(|| "expected a JSON object")?;
747 .and_then(|o| o.as_str())
748 .ok_or_else(|| "expected `kind` to be a string")?;
750 "none" => Ok(StackProbeType::None),
751 "inline" => Ok(StackProbeType::Inline),
752 "call" => Ok(StackProbeType::Call),
753 "inline-or-call" => {
754 let min_version = object
755 .get("min-llvm-version-for-inline")
756 .and_then(|o| o.as_array())
757 .ok_or_else(|| "expected `min-llvm-version-for-inline` to be an array")?;
758 let mut iter = min_version.into_iter().map(|v| {
759 let int = v.as_u64().ok_or_else(
760 || "expected `min-llvm-version-for-inline` values to be integers",
763 .map_err(|_| "`min-llvm-version-for-inline` values don't convert to u32")
765 let min_llvm_version_for_inline = (
766 iter.next().unwrap_or(Ok(11))?,
767 iter.next().unwrap_or(Ok(0))?,
768 iter.next().unwrap_or(Ok(0))?,
770 Ok(StackProbeType::InlineOrCall { min_llvm_version_for_inline })
772 _ => Err(String::from(
773 "`kind` expected to be one of `none`, `inline`, `call` or `inline-or-call`",
779 impl ToJson for StackProbeType {
780 fn to_json(&self) -> Json {
781 Json::Object(match self {
782 StackProbeType::None => {
783 [(String::from("kind"), "none".to_json())].into_iter().collect()
785 StackProbeType::Inline => {
786 [(String::from("kind"), "inline".to_json())].into_iter().collect()
788 StackProbeType::Call => {
789 [(String::from("kind"), "call".to_json())].into_iter().collect()
791 StackProbeType::InlineOrCall { min_llvm_version_for_inline: (maj, min, patch) } => [
792 (String::from("kind"), "inline-or-call".to_json()),
794 String::from("min-llvm-version-for-inline"),
795 Json::Array(vec![maj.to_json(), min.to_json(), patch.to_json()]),
804 bitflags::bitflags! {
805 #[derive(Default, Encodable, Decodable)]
806 pub struct SanitizerSet: u8 {
807 const ADDRESS = 1 << 0;
809 const MEMORY = 1 << 2;
810 const THREAD = 1 << 3;
811 const HWADDRESS = 1 << 4;
813 const MEMTAG = 1 << 6;
814 const SHADOWCALLSTACK = 1 << 7;
819 /// Return sanitizer's name
821 /// Returns none if the flags is a set of sanitizers numbering not exactly one.
822 pub fn as_str(self) -> Option<&'static str> {
824 SanitizerSet::ADDRESS => "address",
825 SanitizerSet::CFI => "cfi",
826 SanitizerSet::LEAK => "leak",
827 SanitizerSet::MEMORY => "memory",
828 SanitizerSet::MEMTAG => "memtag",
829 SanitizerSet::SHADOWCALLSTACK => "shadow-call-stack",
830 SanitizerSet::THREAD => "thread",
831 SanitizerSet::HWADDRESS => "hwaddress",
837 /// Formats a sanitizer set as a comma separated list of sanitizers' names.
838 impl fmt::Display for SanitizerSet {
839 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
840 let mut first = true;
842 let name = s.as_str().unwrap_or_else(|| panic!("unrecognized sanitizer {:?}", s));
853 impl IntoIterator for SanitizerSet {
854 type Item = SanitizerSet;
855 type IntoIter = std::vec::IntoIter<SanitizerSet>;
857 fn into_iter(self) -> Self::IntoIter {
859 SanitizerSet::ADDRESS,
862 SanitizerSet::MEMORY,
863 SanitizerSet::MEMTAG,
864 SanitizerSet::SHADOWCALLSTACK,
865 SanitizerSet::THREAD,
866 SanitizerSet::HWADDRESS,
870 .filter(|&s| self.contains(s))
876 impl<CTX> HashStable<CTX> for SanitizerSet {
877 fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher) {
878 self.bits().hash_stable(ctx, hasher);
882 impl ToJson for SanitizerSet {
883 fn to_json(&self) -> Json {
885 .map(|v| Some(v.as_str()?.to_json()))
886 .collect::<Option<Vec<_>>>()
892 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
893 pub enum FramePointer {
894 /// Forces the machine code generator to always preserve the frame pointers.
896 /// Forces the machine code generator to preserve the frame pointers except for the leaf
897 /// functions (i.e. those that don't call other functions).
899 /// Allows the machine code generator to omit the frame pointers.
901 /// This option does not guarantee that the frame pointers will be omitted.
905 impl FromStr for FramePointer {
907 fn from_str(s: &str) -> Result<Self, ()> {
909 "always" => Self::Always,
910 "non-leaf" => Self::NonLeaf,
911 "may-omit" => Self::MayOmit,
917 impl ToJson for FramePointer {
918 fn to_json(&self) -> Json {
920 Self::Always => "always",
921 Self::NonLeaf => "non-leaf",
922 Self::MayOmit => "may-omit",
928 /// Controls use of stack canaries.
929 #[derive(Clone, Copy, Debug, PartialEq, Hash, Eq)]
930 pub enum StackProtector {
931 /// Disable stack canary generation.
934 /// On LLVM, mark all generated LLVM functions with the `ssp` attribute (see
935 /// llvm/docs/LangRef.rst). This triggers stack canary generation in
936 /// functions which contain an array of a byte-sized type with more than
940 /// On LLVM, mark all generated LLVM functions with the `sspstrong`
941 /// attribute (see llvm/docs/LangRef.rst). This triggers stack canary
942 /// generation in functions which either contain an array, or which take
943 /// the address of a local variable.
946 /// Generate stack canaries in all functions.
950 impl StackProtector {
951 fn as_str(&self) -> &'static str {
953 StackProtector::None => "none",
954 StackProtector::Basic => "basic",
955 StackProtector::Strong => "strong",
956 StackProtector::All => "all",
961 impl FromStr for StackProtector {
964 fn from_str(s: &str) -> Result<StackProtector, ()> {
966 "none" => StackProtector::None,
967 "basic" => StackProtector::Basic,
968 "strong" => StackProtector::Strong,
969 "all" => StackProtector::All,
975 impl fmt::Display for StackProtector {
976 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
977 f.write_str(self.as_str())
981 macro_rules! supported_targets {
982 ( $(($triple:literal, $module:ident ),)+ ) => {
985 /// List of supported targets
986 pub const TARGETS: &[&str] = &[$($triple),+];
988 fn load_builtin(target: &str) -> Option<Target> {
989 let mut t = match target {
990 $( $triple => $module::target(), )+
994 debug!("got builtin target: {:?}", t);
1002 // Cannot put this into a separate file without duplication, make an exception.
1004 #[test] // `#[test]`
1006 tests_impl::test_target(super::$module::target(), $triple);
1013 supported_targets! {
1014 ("x86_64-unknown-linux-gnu", x86_64_unknown_linux_gnu),
1015 ("x86_64-unknown-linux-gnux32", x86_64_unknown_linux_gnux32),
1016 ("i686-unknown-linux-gnu", i686_unknown_linux_gnu),
1017 ("i586-unknown-linux-gnu", i586_unknown_linux_gnu),
1018 ("m68k-unknown-linux-gnu", m68k_unknown_linux_gnu),
1019 ("mips-unknown-linux-gnu", mips_unknown_linux_gnu),
1020 ("mips64-unknown-linux-gnuabi64", mips64_unknown_linux_gnuabi64),
1021 ("mips64el-unknown-linux-gnuabi64", mips64el_unknown_linux_gnuabi64),
1022 ("mipsisa32r6-unknown-linux-gnu", mipsisa32r6_unknown_linux_gnu),
1023 ("mipsisa32r6el-unknown-linux-gnu", mipsisa32r6el_unknown_linux_gnu),
1024 ("mipsisa64r6-unknown-linux-gnuabi64", mipsisa64r6_unknown_linux_gnuabi64),
1025 ("mipsisa64r6el-unknown-linux-gnuabi64", mipsisa64r6el_unknown_linux_gnuabi64),
1026 ("mipsel-unknown-linux-gnu", mipsel_unknown_linux_gnu),
1027 ("powerpc-unknown-linux-gnu", powerpc_unknown_linux_gnu),
1028 ("powerpc-unknown-linux-gnuspe", powerpc_unknown_linux_gnuspe),
1029 ("powerpc-unknown-linux-musl", powerpc_unknown_linux_musl),
1030 ("powerpc64-unknown-linux-gnu", powerpc64_unknown_linux_gnu),
1031 ("powerpc64-unknown-linux-musl", powerpc64_unknown_linux_musl),
1032 ("powerpc64le-unknown-linux-gnu", powerpc64le_unknown_linux_gnu),
1033 ("powerpc64le-unknown-linux-musl", powerpc64le_unknown_linux_musl),
1034 ("s390x-unknown-linux-gnu", s390x_unknown_linux_gnu),
1035 ("s390x-unknown-linux-musl", s390x_unknown_linux_musl),
1036 ("sparc-unknown-linux-gnu", sparc_unknown_linux_gnu),
1037 ("sparc64-unknown-linux-gnu", sparc64_unknown_linux_gnu),
1038 ("arm-unknown-linux-gnueabi", arm_unknown_linux_gnueabi),
1039 ("arm-unknown-linux-gnueabihf", arm_unknown_linux_gnueabihf),
1040 ("armeb-unknown-linux-gnueabi", armeb_unknown_linux_gnueabi),
1041 ("arm-unknown-linux-musleabi", arm_unknown_linux_musleabi),
1042 ("arm-unknown-linux-musleabihf", arm_unknown_linux_musleabihf),
1043 ("armv4t-unknown-linux-gnueabi", armv4t_unknown_linux_gnueabi),
1044 ("armv5te-unknown-linux-gnueabi", armv5te_unknown_linux_gnueabi),
1045 ("armv5te-unknown-linux-musleabi", armv5te_unknown_linux_musleabi),
1046 ("armv5te-unknown-linux-uclibceabi", armv5te_unknown_linux_uclibceabi),
1047 ("armv7-unknown-linux-gnueabi", armv7_unknown_linux_gnueabi),
1048 ("armv7-unknown-linux-gnueabihf", armv7_unknown_linux_gnueabihf),
1049 ("thumbv7neon-unknown-linux-gnueabihf", thumbv7neon_unknown_linux_gnueabihf),
1050 ("thumbv7neon-unknown-linux-musleabihf", thumbv7neon_unknown_linux_musleabihf),
1051 ("armv7-unknown-linux-musleabi", armv7_unknown_linux_musleabi),
1052 ("armv7-unknown-linux-musleabihf", armv7_unknown_linux_musleabihf),
1053 ("aarch64-unknown-linux-gnu", aarch64_unknown_linux_gnu),
1054 ("aarch64-unknown-linux-musl", aarch64_unknown_linux_musl),
1055 ("x86_64-unknown-linux-musl", x86_64_unknown_linux_musl),
1056 ("i686-unknown-linux-musl", i686_unknown_linux_musl),
1057 ("i586-unknown-linux-musl", i586_unknown_linux_musl),
1058 ("mips-unknown-linux-musl", mips_unknown_linux_musl),
1059 ("mipsel-unknown-linux-musl", mipsel_unknown_linux_musl),
1060 ("mips64-unknown-linux-muslabi64", mips64_unknown_linux_muslabi64),
1061 ("mips64el-unknown-linux-muslabi64", mips64el_unknown_linux_muslabi64),
1062 ("hexagon-unknown-linux-musl", hexagon_unknown_linux_musl),
1064 ("mips-unknown-linux-uclibc", mips_unknown_linux_uclibc),
1065 ("mipsel-unknown-linux-uclibc", mipsel_unknown_linux_uclibc),
1067 ("i686-linux-android", i686_linux_android),
1068 ("x86_64-linux-android", x86_64_linux_android),
1069 ("arm-linux-androideabi", arm_linux_androideabi),
1070 ("armv7-linux-androideabi", armv7_linux_androideabi),
1071 ("thumbv7neon-linux-androideabi", thumbv7neon_linux_androideabi),
1072 ("aarch64-linux-android", aarch64_linux_android),
1074 ("x86_64-unknown-none-linuxkernel", x86_64_unknown_none_linuxkernel),
1076 ("aarch64-unknown-freebsd", aarch64_unknown_freebsd),
1077 ("armv6-unknown-freebsd", armv6_unknown_freebsd),
1078 ("armv7-unknown-freebsd", armv7_unknown_freebsd),
1079 ("i686-unknown-freebsd", i686_unknown_freebsd),
1080 ("powerpc-unknown-freebsd", powerpc_unknown_freebsd),
1081 ("powerpc64-unknown-freebsd", powerpc64_unknown_freebsd),
1082 ("powerpc64le-unknown-freebsd", powerpc64le_unknown_freebsd),
1083 ("riscv64gc-unknown-freebsd", riscv64gc_unknown_freebsd),
1084 ("x86_64-unknown-freebsd", x86_64_unknown_freebsd),
1086 ("x86_64-unknown-dragonfly", x86_64_unknown_dragonfly),
1088 ("aarch64-unknown-openbsd", aarch64_unknown_openbsd),
1089 ("i686-unknown-openbsd", i686_unknown_openbsd),
1090 ("powerpc-unknown-openbsd", powerpc_unknown_openbsd),
1091 ("powerpc64-unknown-openbsd", powerpc64_unknown_openbsd),
1092 ("riscv64gc-unknown-openbsd", riscv64gc_unknown_openbsd),
1093 ("sparc64-unknown-openbsd", sparc64_unknown_openbsd),
1094 ("x86_64-unknown-openbsd", x86_64_unknown_openbsd),
1096 ("aarch64-unknown-netbsd", aarch64_unknown_netbsd),
1097 ("armv6-unknown-netbsd-eabihf", armv6_unknown_netbsd_eabihf),
1098 ("armv7-unknown-netbsd-eabihf", armv7_unknown_netbsd_eabihf),
1099 ("i686-unknown-netbsd", i686_unknown_netbsd),
1100 ("powerpc-unknown-netbsd", powerpc_unknown_netbsd),
1101 ("sparc64-unknown-netbsd", sparc64_unknown_netbsd),
1102 ("x86_64-unknown-netbsd", x86_64_unknown_netbsd),
1104 ("i686-unknown-haiku", i686_unknown_haiku),
1105 ("x86_64-unknown-haiku", x86_64_unknown_haiku),
1107 ("aarch64-apple-darwin", aarch64_apple_darwin),
1108 ("x86_64-apple-darwin", x86_64_apple_darwin),
1109 ("i686-apple-darwin", i686_apple_darwin),
1111 ("aarch64-fuchsia", aarch64_fuchsia),
1112 ("x86_64-fuchsia", x86_64_fuchsia),
1114 ("avr-unknown-gnu-atmega328", avr_unknown_gnu_atmega328),
1116 ("x86_64-unknown-l4re-uclibc", x86_64_unknown_l4re_uclibc),
1118 ("aarch64-unknown-redox", aarch64_unknown_redox),
1119 ("x86_64-unknown-redox", x86_64_unknown_redox),
1121 ("i386-apple-ios", i386_apple_ios),
1122 ("x86_64-apple-ios", x86_64_apple_ios),
1123 ("aarch64-apple-ios", aarch64_apple_ios),
1124 ("armv7-apple-ios", armv7_apple_ios),
1125 ("armv7s-apple-ios", armv7s_apple_ios),
1126 ("x86_64-apple-ios-macabi", x86_64_apple_ios_macabi),
1127 ("aarch64-apple-ios-macabi", aarch64_apple_ios_macabi),
1128 ("aarch64-apple-ios-sim", aarch64_apple_ios_sim),
1129 ("aarch64-apple-tvos", aarch64_apple_tvos),
1130 ("x86_64-apple-tvos", x86_64_apple_tvos),
1132 ("armv7k-apple-watchos", armv7k_apple_watchos),
1133 ("arm64_32-apple-watchos", arm64_32_apple_watchos),
1134 ("x86_64-apple-watchos-sim", x86_64_apple_watchos_sim),
1135 ("aarch64-apple-watchos-sim", aarch64_apple_watchos_sim),
1137 ("armebv7r-none-eabi", armebv7r_none_eabi),
1138 ("armebv7r-none-eabihf", armebv7r_none_eabihf),
1139 ("armv7r-none-eabi", armv7r_none_eabi),
1140 ("armv7r-none-eabihf", armv7r_none_eabihf),
1142 ("x86_64-pc-solaris", x86_64_pc_solaris),
1143 ("x86_64-sun-solaris", x86_64_sun_solaris),
1144 ("sparcv9-sun-solaris", sparcv9_sun_solaris),
1146 ("x86_64-unknown-illumos", x86_64_unknown_illumos),
1148 ("x86_64-pc-windows-gnu", x86_64_pc_windows_gnu),
1149 ("i686-pc-windows-gnu", i686_pc_windows_gnu),
1150 ("i686-uwp-windows-gnu", i686_uwp_windows_gnu),
1151 ("x86_64-uwp-windows-gnu", x86_64_uwp_windows_gnu),
1153 ("aarch64-pc-windows-gnullvm", aarch64_pc_windows_gnullvm),
1154 ("x86_64-pc-windows-gnullvm", x86_64_pc_windows_gnullvm),
1156 ("aarch64-pc-windows-msvc", aarch64_pc_windows_msvc),
1157 ("aarch64-uwp-windows-msvc", aarch64_uwp_windows_msvc),
1158 ("x86_64-pc-windows-msvc", x86_64_pc_windows_msvc),
1159 ("x86_64-uwp-windows-msvc", x86_64_uwp_windows_msvc),
1160 ("i686-pc-windows-msvc", i686_pc_windows_msvc),
1161 ("i686-uwp-windows-msvc", i686_uwp_windows_msvc),
1162 ("i586-pc-windows-msvc", i586_pc_windows_msvc),
1163 ("thumbv7a-pc-windows-msvc", thumbv7a_pc_windows_msvc),
1164 ("thumbv7a-uwp-windows-msvc", thumbv7a_uwp_windows_msvc),
1166 ("asmjs-unknown-emscripten", asmjs_unknown_emscripten),
1167 ("wasm32-unknown-emscripten", wasm32_unknown_emscripten),
1168 ("wasm32-unknown-unknown", wasm32_unknown_unknown),
1169 ("wasm32-wasi", wasm32_wasi),
1170 ("wasm64-unknown-unknown", wasm64_unknown_unknown),
1172 ("thumbv6m-none-eabi", thumbv6m_none_eabi),
1173 ("thumbv7m-none-eabi", thumbv7m_none_eabi),
1174 ("thumbv7em-none-eabi", thumbv7em_none_eabi),
1175 ("thumbv7em-none-eabihf", thumbv7em_none_eabihf),
1176 ("thumbv8m.base-none-eabi", thumbv8m_base_none_eabi),
1177 ("thumbv8m.main-none-eabi", thumbv8m_main_none_eabi),
1178 ("thumbv8m.main-none-eabihf", thumbv8m_main_none_eabihf),
1180 ("armv7a-none-eabi", armv7a_none_eabi),
1181 ("armv7a-none-eabihf", armv7a_none_eabihf),
1183 ("msp430-none-elf", msp430_none_elf),
1185 ("aarch64-unknown-hermit", aarch64_unknown_hermit),
1186 ("x86_64-unknown-hermit", x86_64_unknown_hermit),
1188 ("riscv32i-unknown-none-elf", riscv32i_unknown_none_elf),
1189 ("riscv32im-unknown-none-elf", riscv32im_unknown_none_elf),
1190 ("riscv32imc-unknown-none-elf", riscv32imc_unknown_none_elf),
1191 ("riscv32imc-esp-espidf", riscv32imc_esp_espidf),
1192 ("riscv32imac-unknown-none-elf", riscv32imac_unknown_none_elf),
1193 ("riscv32imac-unknown-xous-elf", riscv32imac_unknown_xous_elf),
1194 ("riscv32gc-unknown-linux-gnu", riscv32gc_unknown_linux_gnu),
1195 ("riscv32gc-unknown-linux-musl", riscv32gc_unknown_linux_musl),
1196 ("riscv64imac-unknown-none-elf", riscv64imac_unknown_none_elf),
1197 ("riscv64gc-unknown-none-elf", riscv64gc_unknown_none_elf),
1198 ("riscv64gc-unknown-linux-gnu", riscv64gc_unknown_linux_gnu),
1199 ("riscv64gc-unknown-linux-musl", riscv64gc_unknown_linux_musl),
1201 ("aarch64-unknown-none", aarch64_unknown_none),
1202 ("aarch64-unknown-none-softfloat", aarch64_unknown_none_softfloat),
1204 ("x86_64-fortanix-unknown-sgx", x86_64_fortanix_unknown_sgx),
1206 ("x86_64-unknown-uefi", x86_64_unknown_uefi),
1207 ("i686-unknown-uefi", i686_unknown_uefi),
1208 ("aarch64-unknown-uefi", aarch64_unknown_uefi),
1210 ("nvptx64-nvidia-cuda", nvptx64_nvidia_cuda),
1212 ("i686-wrs-vxworks", i686_wrs_vxworks),
1213 ("x86_64-wrs-vxworks", x86_64_wrs_vxworks),
1214 ("armv7-wrs-vxworks-eabihf", armv7_wrs_vxworks_eabihf),
1215 ("aarch64-wrs-vxworks", aarch64_wrs_vxworks),
1216 ("powerpc-wrs-vxworks", powerpc_wrs_vxworks),
1217 ("powerpc-wrs-vxworks-spe", powerpc_wrs_vxworks_spe),
1218 ("powerpc64-wrs-vxworks", powerpc64_wrs_vxworks),
1220 ("aarch64-kmc-solid_asp3", aarch64_kmc_solid_asp3),
1221 ("armv7a-kmc-solid_asp3-eabi", armv7a_kmc_solid_asp3_eabi),
1222 ("armv7a-kmc-solid_asp3-eabihf", armv7a_kmc_solid_asp3_eabihf),
1224 ("mipsel-sony-psp", mipsel_sony_psp),
1225 ("mipsel-unknown-none", mipsel_unknown_none),
1226 ("thumbv4t-none-eabi", thumbv4t_none_eabi),
1227 ("armv4t-none-eabi", armv4t_none_eabi),
1228 ("thumbv5te-none-eabi", thumbv5te_none_eabi),
1229 ("armv5te-none-eabi", armv5te_none_eabi),
1231 ("aarch64_be-unknown-linux-gnu", aarch64_be_unknown_linux_gnu),
1232 ("aarch64-unknown-linux-gnu_ilp32", aarch64_unknown_linux_gnu_ilp32),
1233 ("aarch64_be-unknown-linux-gnu_ilp32", aarch64_be_unknown_linux_gnu_ilp32),
1235 ("bpfeb-unknown-none", bpfeb_unknown_none),
1236 ("bpfel-unknown-none", bpfel_unknown_none),
1238 ("armv6k-nintendo-3ds", armv6k_nintendo_3ds),
1240 ("aarch64-nintendo-switch-freestanding", aarch64_nintendo_switch_freestanding),
1242 ("armv7-unknown-linux-uclibceabi", armv7_unknown_linux_uclibceabi),
1243 ("armv7-unknown-linux-uclibceabihf", armv7_unknown_linux_uclibceabihf),
1245 ("x86_64-unknown-none", x86_64_unknown_none),
1247 ("mips64-openwrt-linux-musl", mips64_openwrt_linux_musl),
1250 /// Cow-Vec-Str: Cow<'static, [Cow<'static, str>]>
1253 ::std::borrow::Cow::Borrowed(&[])
1255 ($($x:expr),+ $(,)?) => {
1256 ::std::borrow::Cow::Borrowed(&[
1258 ::std::borrow::Cow::Borrowed($x),
1266 /// Warnings encountered when parsing the target `json`.
1268 /// Includes fields that weren't recognized and fields that don't have the expected type.
1269 #[derive(Debug, PartialEq)]
1270 pub struct TargetWarnings {
1271 unused_fields: Vec<String>,
1272 incorrect_type: Vec<String>,
1275 impl TargetWarnings {
1276 pub fn empty() -> Self {
1277 Self { unused_fields: Vec::new(), incorrect_type: Vec::new() }
1280 pub fn warning_messages(&self) -> Vec<String> {
1281 let mut warnings = vec![];
1282 if !self.unused_fields.is_empty() {
1283 warnings.push(format!(
1284 "target json file contains unused fields: {}",
1285 self.unused_fields.join(", ")
1288 if !self.incorrect_type.is_empty() {
1289 warnings.push(format!(
1290 "target json file contains fields whose value doesn't have the correct json type: {}",
1291 self.incorrect_type.join(", ")
1298 /// Everything `rustc` knows about how to compile for a specific target.
1300 /// Every field here must be specified, and has no default value.
1301 #[derive(PartialEq, Clone, Debug)]
1303 /// Target triple to pass to LLVM.
1304 pub llvm_target: StaticCow<str>,
1305 /// Number of bits in a pointer. Influences the `target_pointer_width` `cfg` variable.
1306 pub pointer_width: u32,
1307 /// Architecture to use for ABI considerations. Valid options include: "x86",
1308 /// "x86_64", "arm", "aarch64", "mips", "powerpc", "powerpc64", and others.
1309 pub arch: StaticCow<str>,
1310 /// [Data layout](https://llvm.org/docs/LangRef.html#data-layout) to pass to LLVM.
1311 pub data_layout: StaticCow<str>,
1312 /// Optional settings with defaults.
1313 pub options: TargetOptions,
1316 pub trait HasTargetSpec {
1317 fn target_spec(&self) -> &Target;
1320 impl HasTargetSpec for Target {
1322 fn target_spec(&self) -> &Target {
1327 type StaticCow<T> = Cow<'static, T>;
1329 /// Optional aspects of a target specification.
1331 /// This has an implementation of `Default`, see each field for what the default is. In general,
1332 /// these try to take "minimal defaults" that don't assume anything about the runtime they run in.
1334 /// `TargetOptions` as a separate structure is mostly an implementation detail of `Target`
1335 /// construction, all its fields logically belong to `Target` and available from `Target`
1336 /// through `Deref` impls.
1337 #[derive(PartialEq, Clone, Debug)]
1338 pub struct TargetOptions {
1339 /// Whether the target is built-in or loaded from a custom target specification.
1340 pub is_builtin: bool,
1342 /// Used as the `target_endian` `cfg` variable. Defaults to little endian.
1344 /// Width of c_int type. Defaults to "32".
1345 pub c_int_width: StaticCow<str>,
1346 /// OS name to use for conditional compilation (`target_os`). Defaults to "none".
1347 /// "none" implies a bare metal target without `std` library.
1348 /// A couple of targets having `std` also use "unknown" as an `os` value,
1349 /// but they are exceptions.
1350 pub os: StaticCow<str>,
1351 /// Environment name to use for conditional compilation (`target_env`). Defaults to "".
1352 pub env: StaticCow<str>,
1353 /// ABI name to distinguish multiple ABIs on the same OS and architecture. For instance, `"eabi"`
1354 /// or `"eabihf"`. Defaults to "".
1355 pub abi: StaticCow<str>,
1356 /// Vendor name to use for conditional compilation (`target_vendor`). Defaults to "unknown".
1357 pub vendor: StaticCow<str>,
1359 /// Linker to invoke
1360 pub linker: Option<StaticCow<str>>,
1361 /// Default linker flavor used if `-C linker-flavor` or `-C linker` are not passed
1362 /// on the command line. Defaults to `LinkerFlavor::Gnu(Cc::Yes, Lld::No)`.
1363 pub linker_flavor: LinkerFlavor,
1364 linker_flavor_json: LinkerFlavorCli,
1365 lld_flavor_json: LldFlavor,
1366 linker_is_gnu_json: bool,
1368 /// Objects to link before and after all other object code.
1369 pub pre_link_objects: CrtObjects,
1370 pub post_link_objects: CrtObjects,
1371 /// Same as `(pre|post)_link_objects`, but when self-contained linking mode is enabled.
1372 pub pre_link_objects_self_contained: CrtObjects,
1373 pub post_link_objects_self_contained: CrtObjects,
1374 pub link_self_contained: LinkSelfContainedDefault,
1376 /// Linker arguments that are passed *before* any user-defined libraries.
1377 pub pre_link_args: LinkArgs,
1378 pre_link_args_json: LinkArgsCli,
1379 /// Linker arguments that are unconditionally passed after any
1380 /// user-defined but before post-link objects. Standard platform
1381 /// libraries that should be always be linked to, usually go here.
1382 pub late_link_args: LinkArgs,
1383 late_link_args_json: LinkArgsCli,
1384 /// Linker arguments used in addition to `late_link_args` if at least one
1385 /// Rust dependency is dynamically linked.
1386 pub late_link_args_dynamic: LinkArgs,
1387 late_link_args_dynamic_json: LinkArgsCli,
1388 /// Linker arguments used in addition to `late_link_args` if all Rust
1389 /// dependencies are statically linked.
1390 pub late_link_args_static: LinkArgs,
1391 late_link_args_static_json: LinkArgsCli,
1392 /// Linker arguments that are unconditionally passed *after* any
1393 /// user-defined libraries.
1394 pub post_link_args: LinkArgs,
1395 post_link_args_json: LinkArgsCli,
1397 /// Optional link script applied to `dylib` and `executable` crate types.
1398 /// This is a string containing the script, not a path. Can only be applied
1399 /// to linkers where linker flavor matches `LinkerFlavor::Gnu(..)`.
1400 pub link_script: Option<StaticCow<str>>,
1401 /// Environment variables to be set for the linker invocation.
1402 pub link_env: StaticCow<[(StaticCow<str>, StaticCow<str>)]>,
1403 /// Environment variables to be removed for the linker invocation.
1404 pub link_env_remove: StaticCow<[StaticCow<str>]>,
1406 /// Extra arguments to pass to the external assembler (when used)
1407 pub asm_args: StaticCow<[StaticCow<str>]>,
1409 /// Default CPU to pass to LLVM. Corresponds to `llc -mcpu=$cpu`. Defaults
1411 pub cpu: StaticCow<str>,
1412 /// Default target features to pass to LLVM. These features will *always* be
1413 /// passed, and cannot be disabled even via `-C`. Corresponds to `llc
1414 /// -mattr=$features`.
1415 pub features: StaticCow<str>,
1416 /// Whether dynamic linking is available on this target. Defaults to false.
1417 pub dynamic_linking: bool,
1418 /// If dynamic linking is available, whether only cdylibs are supported.
1419 pub only_cdylib: bool,
1420 /// Whether executables are available on this target. Defaults to true.
1421 pub executables: bool,
1422 /// Relocation model to use in object file. Corresponds to `llc
1423 /// -relocation-model=$relocation_model`. Defaults to `Pic`.
1424 pub relocation_model: RelocModel,
1425 /// Code model to use. Corresponds to `llc -code-model=$code_model`.
1426 /// Defaults to `None` which means "inherited from the base LLVM target".
1427 pub code_model: Option<CodeModel>,
1428 /// TLS model to use. Options are "global-dynamic" (default), "local-dynamic", "initial-exec"
1429 /// and "local-exec". This is similar to the -ftls-model option in GCC/Clang.
1430 pub tls_model: TlsModel,
1431 /// Do not emit code that uses the "red zone", if the ABI has one. Defaults to false.
1432 pub disable_redzone: bool,
1433 /// Frame pointer mode for this target. Defaults to `MayOmit`.
1434 pub frame_pointer: FramePointer,
1435 /// Emit each function in its own section. Defaults to true.
1436 pub function_sections: bool,
1437 /// String to prepend to the name of every dynamic library. Defaults to "lib".
1438 pub dll_prefix: StaticCow<str>,
1439 /// String to append to the name of every dynamic library. Defaults to ".so".
1440 pub dll_suffix: StaticCow<str>,
1441 /// String to append to the name of every executable.
1442 pub exe_suffix: StaticCow<str>,
1443 /// String to prepend to the name of every static library. Defaults to "lib".
1444 pub staticlib_prefix: StaticCow<str>,
1445 /// String to append to the name of every static library. Defaults to ".a".
1446 pub staticlib_suffix: StaticCow<str>,
1447 /// Values of the `target_family` cfg set for this target.
1449 /// Common options are: "unix", "windows". Defaults to no families.
1451 /// See <https://doc.rust-lang.org/reference/conditional-compilation.html#target_family>.
1452 pub families: StaticCow<[StaticCow<str>]>,
1453 /// Whether the target toolchain's ABI supports returning small structs as an integer.
1454 pub abi_return_struct_as_int: bool,
1455 /// Whether the target toolchain is like macOS's. Only useful for compiling against iOS/macOS,
1456 /// in particular running dsymutil and some other stuff like `-dead_strip`. Defaults to false.
1457 /// Also indiates whether to use Apple-specific ABI changes, such as extending function
1458 /// parameters to 32-bits.
1459 pub is_like_osx: bool,
1460 /// Whether the target toolchain is like Solaris's.
1461 /// Only useful for compiling against Illumos/Solaris,
1462 /// as they have a different set of linker flags. Defaults to false.
1463 pub is_like_solaris: bool,
1464 /// Whether the target is like Windows.
1465 /// This is a combination of several more specific properties represented as a single flag:
1466 /// - The target uses a Windows ABI,
1467 /// - uses PE/COFF as a format for object code,
1468 /// - uses Windows-style dllexport/dllimport for shared libraries,
1469 /// - uses import libraries and .def files for symbol exports,
1470 /// - executables support setting a subsystem.
1471 pub is_like_windows: bool,
1472 /// Whether the target is like MSVC.
1473 /// This is a combination of several more specific properties represented as a single flag:
1474 /// - The target has all the properties from `is_like_windows`
1475 /// (for in-tree targets "is_like_msvc ⇒ is_like_windows" is ensured by a unit test),
1476 /// - has some MSVC-specific Windows ABI properties,
1477 /// - uses a link.exe-like linker,
1478 /// - uses CodeView/PDB for debuginfo and natvis for its visualization,
1479 /// - uses SEH-based unwinding,
1480 /// - supports control flow guard mechanism.
1481 pub is_like_msvc: bool,
1482 /// Whether a target toolchain is like WASM.
1483 pub is_like_wasm: bool,
1484 /// Whether a target toolchain is like Android, implying a Linux kernel and a Bionic libc
1485 pub is_like_android: bool,
1486 /// Default supported version of DWARF on this platform.
1487 /// Useful because some platforms (osx, bsd) only want up to DWARF2.
1488 pub default_dwarf_version: u32,
1489 /// The MinGW toolchain has a known issue that prevents it from correctly
1490 /// handling COFF object files with more than 2<sup>15</sup> sections. Since each weak
1491 /// symbol needs its own COMDAT section, weak linkage implies a large
1492 /// number sections that easily exceeds the given limit for larger
1493 /// codebases. Consequently we want a way to disallow weak linkage on some
1495 pub allows_weak_linkage: bool,
1496 /// Whether the linker support rpaths or not. Defaults to false.
1497 pub has_rpath: bool,
1498 /// Whether to disable linking to the default libraries, typically corresponds
1499 /// to `-nodefaultlibs`. Defaults to true.
1500 pub no_default_libraries: bool,
1501 /// Dynamically linked executables can be compiled as position independent
1502 /// if the default relocation model of position independent code is not
1503 /// changed. This is a requirement to take advantage of ASLR, as otherwise
1504 /// the functions in the executable are not randomized and can be used
1505 /// during an exploit of a vulnerability in any code.
1506 pub position_independent_executables: bool,
1507 /// Executables that are both statically linked and position-independent are supported.
1508 pub static_position_independent_executables: bool,
1509 /// Determines if the target always requires using the PLT for indirect
1510 /// library calls or not. This controls the default value of the `-Z plt` flag.
1511 pub needs_plt: bool,
1512 /// Either partial, full, or off. Full RELRO makes the dynamic linker
1513 /// resolve all symbols at startup and marks the GOT read-only before
1514 /// starting the program, preventing overwriting the GOT.
1515 pub relro_level: RelroLevel,
1516 /// Format that archives should be emitted in. This affects whether we use
1517 /// LLVM to assemble an archive or fall back to the system linker, and
1518 /// currently only "gnu" is used to fall into LLVM. Unknown strings cause
1519 /// the system linker to be used.
1520 pub archive_format: StaticCow<str>,
1521 /// Is asm!() allowed? Defaults to true.
1522 pub allow_asm: bool,
1523 /// Whether the runtime startup code requires the `main` function be passed
1524 /// `argc` and `argv` values.
1525 pub main_needs_argc_argv: bool,
1527 /// Flag indicating whether #[thread_local] is available for this target.
1528 pub has_thread_local: bool,
1529 // This is mainly for easy compatibility with emscripten.
1530 // If we give emcc .o files that are actually .bc files it
1531 // will 'just work'.
1532 pub obj_is_bitcode: bool,
1533 /// Whether the target requires that emitted object code includes bitcode.
1534 pub forces_embed_bitcode: bool,
1535 /// Content of the LLVM cmdline section associated with embedded bitcode.
1536 pub bitcode_llvm_cmdline: StaticCow<str>,
1538 /// Don't use this field; instead use the `.min_atomic_width()` method.
1539 pub min_atomic_width: Option<u64>,
1541 /// Don't use this field; instead use the `.max_atomic_width()` method.
1542 pub max_atomic_width: Option<u64>,
1544 /// Whether the target supports atomic CAS operations natively
1545 pub atomic_cas: bool,
1547 /// Panic strategy: "unwind" or "abort"
1548 pub panic_strategy: PanicStrategy,
1550 /// Whether or not linking dylibs to a static CRT is allowed.
1551 pub crt_static_allows_dylibs: bool,
1552 /// Whether or not the CRT is statically linked by default.
1553 pub crt_static_default: bool,
1554 /// Whether or not crt-static is respected by the compiler (or is a no-op).
1555 pub crt_static_respected: bool,
1557 /// The implementation of stack probes to use.
1558 pub stack_probes: StackProbeType,
1560 /// The minimum alignment for global symbols.
1561 pub min_global_align: Option<u64>,
1563 /// Default number of codegen units to use in debug mode
1564 pub default_codegen_units: Option<u64>,
1566 /// Whether to generate trap instructions in places where optimization would
1567 /// otherwise produce control flow that falls through into unrelated memory.
1568 pub trap_unreachable: bool,
1570 /// This target requires everything to be compiled with LTO to emit a final
1571 /// executable, aka there is no native linker for this target.
1572 pub requires_lto: bool,
1574 /// This target has no support for threads.
1575 pub singlethread: bool,
1577 /// Whether library functions call lowering/optimization is disabled in LLVM
1578 /// for this target unconditionally.
1579 pub no_builtins: bool,
1581 /// The default visibility for symbols in this target should be "hidden"
1582 /// rather than "default"
1583 pub default_hidden_visibility: bool,
1585 /// Whether a .debug_gdb_scripts section will be added to the output object file
1586 pub emit_debug_gdb_scripts: bool,
1588 /// Whether or not to unconditionally `uwtable` attributes on functions,
1589 /// typically because the platform needs to unwind for things like stack
1591 pub requires_uwtable: bool,
1593 /// Whether or not to emit `uwtable` attributes on functions if `-C force-unwind-tables`
1594 /// is not specified and `uwtable` is not required on this target.
1595 pub default_uwtable: bool,
1597 /// Whether or not SIMD types are passed by reference in the Rust ABI,
1598 /// typically required if a target can be compiled with a mixed set of
1599 /// target features. This is `true` by default, and `false` for targets like
1600 /// wasm32 where the whole program either has simd or not.
1601 pub simd_types_indirect: bool,
1603 /// Pass a list of symbol which should be exported in the dylib to the linker.
1604 pub limit_rdylib_exports: bool,
1606 /// If set, have the linker export exactly these symbols, instead of using
1607 /// the usual logic to figure this out from the crate itself.
1608 pub override_export_symbols: Option<StaticCow<[StaticCow<str>]>>,
1610 /// Determines how or whether the MergeFunctions LLVM pass should run for
1611 /// this target. Either "disabled", "trampolines", or "aliases".
1612 /// The MergeFunctions pass is generally useful, but some targets may need
1613 /// to opt out. The default is "aliases".
1615 /// Workaround for: <https://github.com/rust-lang/rust/issues/57356>
1616 pub merge_functions: MergeFunctions,
1618 /// Use platform dependent mcount function
1619 pub mcount: StaticCow<str>,
1621 /// LLVM ABI name, corresponds to the '-mabi' parameter available in multilib C compilers
1622 pub llvm_abiname: StaticCow<str>,
1624 /// Whether or not RelaxElfRelocation flag will be passed to the linker
1625 pub relax_elf_relocations: bool,
1627 /// Additional arguments to pass to LLVM, similar to the `-C llvm-args` codegen option.
1628 pub llvm_args: StaticCow<[StaticCow<str>]>,
1630 /// Whether to use legacy .ctors initialization hooks rather than .init_array. Defaults
1631 /// to false (uses .init_array).
1632 pub use_ctors_section: bool,
1634 /// Whether the linker is instructed to add a `GNU_EH_FRAME` ELF header
1635 /// used to locate unwinding information is passed
1636 /// (only has effect if the linker is `ld`-like).
1637 pub eh_frame_header: bool,
1639 /// Is true if the target is an ARM architecture using thumb v1 which allows for
1640 /// thumb and arm interworking.
1641 pub has_thumb_interworking: bool,
1643 /// Which kind of debuginfo is used by this target?
1644 pub debuginfo_kind: DebuginfoKind,
1645 /// How to handle split debug information, if at all. Specifying `None` has
1646 /// target-specific meaning.
1647 pub split_debuginfo: SplitDebuginfo,
1648 /// Which kinds of split debuginfo are supported by the target?
1649 pub supported_split_debuginfo: StaticCow<[SplitDebuginfo]>,
1651 /// The sanitizers supported by this target
1653 /// Note that the support here is at a codegen level. If the machine code with sanitizer
1654 /// enabled can generated on this target, but the necessary supporting libraries are not
1655 /// distributed with the target, the sanitizer should still appear in this list for the target.
1656 pub supported_sanitizers: SanitizerSet,
1658 /// If present it's a default value to use for adjusting the C ABI.
1659 pub default_adjusted_cabi: Option<Abi>,
1661 /// Minimum number of bits in #[repr(C)] enum. Defaults to 32.
1662 pub c_enum_min_bits: u64,
1664 /// Whether or not the DWARF `.debug_aranges` section should be generated.
1665 pub generate_arange_section: bool,
1667 /// Whether the target supports stack canary checks. `true` by default,
1668 /// since this is most common among tier 1 and tier 2 targets.
1669 pub supports_stack_protector: bool,
1672 /// Add arguments for the given flavor and also for its "twin" flavors
1673 /// that have a compatible command line interface.
1674 fn add_link_args_iter(
1675 link_args: &mut LinkArgs,
1676 flavor: LinkerFlavor,
1677 args: impl Iterator<Item = StaticCow<str>> + Clone,
1679 let mut insert = |flavor| link_args.entry(flavor).or_default().extend(args.clone());
1682 LinkerFlavor::Gnu(cc, lld) => {
1683 assert_eq!(lld, Lld::No);
1684 insert(LinkerFlavor::Gnu(cc, Lld::Yes));
1686 LinkerFlavor::Darwin(cc, lld) => {
1687 assert_eq!(lld, Lld::No);
1688 insert(LinkerFlavor::Darwin(cc, Lld::Yes));
1690 LinkerFlavor::Msvc(lld) => {
1691 assert_eq!(lld, Lld::No);
1692 insert(LinkerFlavor::Msvc(Lld::Yes));
1694 LinkerFlavor::WasmLld(..)
1695 | LinkerFlavor::Unix(..)
1696 | LinkerFlavor::EmCc
1698 | LinkerFlavor::Ptx => {}
1702 fn add_link_args(link_args: &mut LinkArgs, flavor: LinkerFlavor, args: &[&'static str]) {
1703 add_link_args_iter(link_args, flavor, args.iter().copied().map(Cow::Borrowed))
1706 impl TargetOptions {
1707 fn link_args(flavor: LinkerFlavor, args: &[&'static str]) -> LinkArgs {
1708 let mut link_args = LinkArgs::new();
1709 add_link_args(&mut link_args, flavor, args);
1713 fn add_pre_link_args(&mut self, flavor: LinkerFlavor, args: &[&'static str]) {
1714 add_link_args(&mut self.pre_link_args, flavor, args);
1717 fn add_post_link_args(&mut self, flavor: LinkerFlavor, args: &[&'static str]) {
1718 add_link_args(&mut self.post_link_args, flavor, args);
1721 fn update_from_cli(&mut self) {
1722 self.linker_flavor = LinkerFlavor::from_cli_impl(
1723 self.linker_flavor_json,
1724 self.lld_flavor_json,
1725 self.linker_is_gnu_json,
1727 for (args, args_json) in [
1728 (&mut self.pre_link_args, &self.pre_link_args_json),
1729 (&mut self.late_link_args, &self.late_link_args_json),
1730 (&mut self.late_link_args_dynamic, &self.late_link_args_dynamic_json),
1731 (&mut self.late_link_args_static, &self.late_link_args_static_json),
1732 (&mut self.post_link_args, &self.post_link_args_json),
1735 for (flavor, args_json) in args_json {
1736 // Cannot use `from_cli` due to borrow checker.
1737 let linker_flavor = LinkerFlavor::from_cli_impl(
1739 self.lld_flavor_json,
1740 self.linker_is_gnu_json,
1742 match linker_flavor {
1743 LinkerFlavor::Gnu(_, Lld::Yes)
1744 | LinkerFlavor::Darwin(_, Lld::Yes)
1745 | LinkerFlavor::Msvc(Lld::Yes) => {}
1746 _ => add_link_args_iter(args, linker_flavor, args_json.iter().cloned()),
1752 fn update_to_cli(&mut self) {
1753 self.linker_flavor_json = self.linker_flavor.to_cli();
1754 self.lld_flavor_json = self.linker_flavor.lld_flavor();
1755 self.linker_is_gnu_json = self.linker_flavor.is_gnu();
1756 for (args, args_json) in [
1757 (&self.pre_link_args, &mut self.pre_link_args_json),
1758 (&self.late_link_args, &mut self.late_link_args_json),
1759 (&self.late_link_args_dynamic, &mut self.late_link_args_dynamic_json),
1760 (&self.late_link_args_static, &mut self.late_link_args_static_json),
1761 (&self.post_link_args, &mut self.post_link_args_json),
1764 args.iter().map(|(flavor, args)| (flavor.to_cli(), args.clone())).collect();
1769 impl Default for TargetOptions {
1770 /// Creates a set of "sane defaults" for any target. This is still
1771 /// incomplete, and if used for compilation, will certainly not work.
1772 fn default() -> TargetOptions {
1775 endian: Endian::Little,
1776 c_int_width: "32".into(),
1780 vendor: "unknown".into(),
1781 linker: option_env!("CFG_DEFAULT_LINKER").map(|s| s.into()),
1782 linker_flavor: LinkerFlavor::Gnu(Cc::Yes, Lld::No),
1783 linker_flavor_json: LinkerFlavorCli::Gcc,
1784 lld_flavor_json: LldFlavor::Ld,
1785 linker_is_gnu_json: true,
1788 cpu: "generic".into(),
1789 features: "".into(),
1790 dynamic_linking: false,
1793 relocation_model: RelocModel::Pic,
1795 tls_model: TlsModel::GeneralDynamic,
1796 disable_redzone: false,
1797 frame_pointer: FramePointer::MayOmit,
1798 function_sections: true,
1799 dll_prefix: "lib".into(),
1800 dll_suffix: ".so".into(),
1801 exe_suffix: "".into(),
1802 staticlib_prefix: "lib".into(),
1803 staticlib_suffix: ".a".into(),
1805 abi_return_struct_as_int: false,
1807 is_like_solaris: false,
1808 is_like_windows: false,
1809 is_like_msvc: false,
1810 is_like_wasm: false,
1811 is_like_android: false,
1812 default_dwarf_version: 4,
1813 allows_weak_linkage: true,
1815 no_default_libraries: true,
1816 position_independent_executables: false,
1817 static_position_independent_executables: false,
1819 relro_level: RelroLevel::None,
1820 pre_link_objects: Default::default(),
1821 post_link_objects: Default::default(),
1822 pre_link_objects_self_contained: Default::default(),
1823 post_link_objects_self_contained: Default::default(),
1824 link_self_contained: LinkSelfContainedDefault::False,
1825 pre_link_args: LinkArgs::new(),
1826 pre_link_args_json: LinkArgsCli::new(),
1827 late_link_args: LinkArgs::new(),
1828 late_link_args_json: LinkArgsCli::new(),
1829 late_link_args_dynamic: LinkArgs::new(),
1830 late_link_args_dynamic_json: LinkArgsCli::new(),
1831 late_link_args_static: LinkArgs::new(),
1832 late_link_args_static_json: LinkArgsCli::new(),
1833 post_link_args: LinkArgs::new(),
1834 post_link_args_json: LinkArgsCli::new(),
1836 link_env_remove: cvs![],
1837 archive_format: "gnu".into(),
1838 main_needs_argc_argv: true,
1840 has_thread_local: false,
1841 obj_is_bitcode: false,
1842 forces_embed_bitcode: false,
1843 bitcode_llvm_cmdline: "".into(),
1844 min_atomic_width: None,
1845 max_atomic_width: None,
1847 panic_strategy: PanicStrategy::Unwind,
1848 crt_static_allows_dylibs: false,
1849 crt_static_default: false,
1850 crt_static_respected: false,
1851 stack_probes: StackProbeType::None,
1852 min_global_align: None,
1853 default_codegen_units: None,
1854 trap_unreachable: true,
1855 requires_lto: false,
1856 singlethread: false,
1858 default_hidden_visibility: false,
1859 emit_debug_gdb_scripts: true,
1860 requires_uwtable: false,
1861 default_uwtable: false,
1862 simd_types_indirect: true,
1863 limit_rdylib_exports: true,
1864 override_export_symbols: None,
1865 merge_functions: MergeFunctions::Aliases,
1866 mcount: "mcount".into(),
1867 llvm_abiname: "".into(),
1868 relax_elf_relocations: false,
1870 use_ctors_section: false,
1871 eh_frame_header: true,
1872 has_thumb_interworking: false,
1873 debuginfo_kind: Default::default(),
1874 split_debuginfo: Default::default(),
1875 // `Off` is supported by default, but targets can remove this manually, e.g. Windows.
1876 supported_split_debuginfo: Cow::Borrowed(&[SplitDebuginfo::Off]),
1877 supported_sanitizers: SanitizerSet::empty(),
1878 default_adjusted_cabi: None,
1879 c_enum_min_bits: 32,
1880 generate_arange_section: true,
1881 supports_stack_protector: true,
1886 /// `TargetOptions` being a separate type is basically an implementation detail of `Target` that is
1887 /// used for providing defaults. Perhaps there's a way to merge `TargetOptions` into `Target` so
1888 /// this `Deref` implementation is no longer necessary.
1889 impl Deref for Target {
1890 type Target = TargetOptions;
1893 fn deref(&self) -> &Self::Target {
1897 impl DerefMut for Target {
1899 fn deref_mut(&mut self) -> &mut Self::Target {
1905 /// Given a function ABI, turn it into the correct ABI for this target.
1906 pub fn adjust_abi(&self, abi: Abi) -> Abi {
1908 Abi::C { .. } => self.default_adjusted_cabi.unwrap_or(abi),
1909 Abi::System { unwind } if self.is_like_windows && self.arch == "x86" => {
1910 Abi::Stdcall { unwind }
1912 Abi::System { unwind } => Abi::C { unwind },
1913 Abi::EfiApi if self.arch == "x86_64" => Abi::Win64 { unwind: false },
1914 Abi::EfiApi => Abi::C { unwind: false },
1916 // See commentary in `is_abi_supported`.
1917 Abi::Stdcall { .. } | Abi::Thiscall { .. } if self.arch == "x86" => abi,
1918 Abi::Stdcall { unwind } | Abi::Thiscall { unwind } => Abi::C { unwind },
1919 Abi::Fastcall { .. } if self.arch == "x86" => abi,
1920 Abi::Vectorcall { .. } if ["x86", "x86_64"].contains(&&self.arch[..]) => abi,
1921 Abi::Fastcall { unwind } | Abi::Vectorcall { unwind } => Abi::C { unwind },
1927 /// Returns a None if the UNSUPPORTED_CALLING_CONVENTIONS lint should be emitted
1928 pub fn is_abi_supported(&self, abi: Abi) -> Option<bool> {
1941 X86Interrupt => ["x86", "x86_64"].contains(&&self.arch[..]),
1942 Aapcs { .. } => "arm" == self.arch,
1943 CCmseNonSecureCall => ["arm", "aarch64"].contains(&&self.arch[..]),
1944 Win64 { .. } | SysV64 { .. } => self.arch == "x86_64",
1945 PtxKernel => self.arch == "nvptx64",
1946 Msp430Interrupt => self.arch == "msp430",
1947 AmdGpuKernel => self.arch == "amdgcn",
1948 AvrInterrupt | AvrNonBlockingInterrupt => self.arch == "avr",
1949 Wasm => ["wasm32", "wasm64"].contains(&&self.arch[..]),
1950 Thiscall { .. } => self.arch == "x86",
1951 // On windows these fall-back to platform native calling convention (C) when the
1952 // architecture is not supported.
1954 // This is I believe a historical accident that has occurred as part of Microsoft
1955 // striving to allow most of the code to "just" compile when support for 64-bit x86
1956 // was added and then later again, when support for ARM architectures was added.
1958 // This is well documented across MSDN. Support for this in Rust has been added in
1959 // #54576. This makes much more sense in context of Microsoft's C++ than it does in
1960 // Rust, but there isn't much leeway remaining here to change it back at the time this
1961 // comment has been written.
1963 // Following are the relevant excerpts from the MSDN documentation.
1965 // > The __vectorcall calling convention is only supported in native code on x86 and
1966 // x64 processors that include Streaming SIMD Extensions 2 (SSE2) and above.
1968 // > On ARM machines, __vectorcall is accepted and ignored by the compiler.
1970 // -- https://docs.microsoft.com/en-us/cpp/cpp/vectorcall?view=msvc-160
1972 // > On ARM and x64 processors, __stdcall is accepted and ignored by the compiler;
1974 // -- https://docs.microsoft.com/en-us/cpp/cpp/stdcall?view=msvc-160
1976 // > In most cases, keywords or compiler switches that specify an unsupported
1977 // > convention on a particular platform are ignored, and the platform default
1978 // > convention is used.
1980 // -- https://docs.microsoft.com/en-us/cpp/cpp/argument-passing-and-naming-conventions
1981 Stdcall { .. } | Fastcall { .. } | Vectorcall { .. } if self.is_like_windows => true,
1982 // Outside of Windows we want to only support these calling conventions for the
1983 // architectures for which these calling conventions are actually well defined.
1984 Stdcall { .. } | Fastcall { .. } if self.arch == "x86" => true,
1985 Vectorcall { .. } if ["x86", "x86_64"].contains(&&self.arch[..]) => true,
1986 // Return a `None` for other cases so that we know to emit a future compat lint.
1987 Stdcall { .. } | Fastcall { .. } | Vectorcall { .. } => return None,
1991 /// Minimum integer size in bits that this target can perform atomic
1993 pub fn min_atomic_width(&self) -> u64 {
1994 self.min_atomic_width.unwrap_or(8)
1997 /// Maximum integer size in bits that this target can perform atomic
1999 pub fn max_atomic_width(&self) -> u64 {
2000 self.max_atomic_width.unwrap_or_else(|| self.pointer_width.into())
2003 /// Loads a target descriptor from a JSON object.
2004 pub fn from_json(obj: Json) -> Result<(Target, TargetWarnings), String> {
2005 // While ugly, this code must remain this way to retain
2006 // compatibility with existing JSON fields and the internal
2007 // expected naming of the Target and TargetOptions structs.
2008 // To ensure compatibility is retained, the built-in targets
2009 // are round-tripped through this code to catch cases where
2010 // the JSON parser is not updated to match the structs.
2012 let mut obj = match obj {
2013 Value::Object(obj) => obj,
2014 _ => return Err("Expected JSON object for target")?,
2017 let mut get_req_field = |name: &str| {
2019 .and_then(|j| j.as_str().map(str::to_string))
2020 .ok_or_else(|| format!("Field {} in target specification is required", name))
2023 let mut base = Target {
2024 llvm_target: get_req_field("llvm-target")?.into(),
2025 pointer_width: get_req_field("target-pointer-width")?
2027 .map_err(|_| "target-pointer-width must be an integer".to_string())?,
2028 data_layout: get_req_field("data-layout")?.into(),
2029 arch: get_req_field("arch")?.into(),
2030 options: Default::default(),
2033 let mut incorrect_type = vec![];
2036 ($key_name:ident) => ( {
2037 let name = (stringify!($key_name)).replace("_", "-");
2038 if let Some(s) = obj.remove(&name).and_then(|s| s.as_str().map(str::to_string).map(Cow::from)) {
2042 ($key_name:ident = $json_name:expr) => ( {
2043 let name = $json_name;
2044 if let Some(s) = obj.remove(name).and_then(|s| s.as_str().map(str::to_string).map(Cow::from)) {
2048 ($key_name:ident, bool) => ( {
2049 let name = (stringify!($key_name)).replace("_", "-");
2050 if let Some(s) = obj.remove(&name).and_then(|b| b.as_bool()) {
2054 ($key_name:ident = $json_name:expr, bool) => ( {
2055 let name = $json_name;
2056 if let Some(s) = obj.remove(name).and_then(|b| b.as_bool()) {
2060 ($key_name:ident, u64) => ( {
2061 let name = (stringify!($key_name)).replace("_", "-");
2062 if let Some(s) = obj.remove(&name).and_then(|j| Json::as_u64(&j)) {
2066 ($key_name:ident, u32) => ( {
2067 let name = (stringify!($key_name)).replace("_", "-");
2068 if let Some(s) = obj.remove(&name).and_then(|b| b.as_u64()) {
2070 return Err("Not a valid DWARF version number".into());
2072 base.$key_name = s as u32;
2075 ($key_name:ident, Option<u64>) => ( {
2076 let name = (stringify!($key_name)).replace("_", "-");
2077 if let Some(s) = obj.remove(&name).and_then(|b| b.as_u64()) {
2078 base.$key_name = Some(s);
2081 ($key_name:ident, MergeFunctions) => ( {
2082 let name = (stringify!($key_name)).replace("_", "-");
2083 obj.remove(&name).and_then(|o| o.as_str().and_then(|s| {
2084 match s.parse::<MergeFunctions>() {
2085 Ok(mergefunc) => base.$key_name = mergefunc,
2086 _ => return Some(Err(format!("'{}' is not a valid value for \
2087 merge-functions. Use 'disabled', \
2088 'trampolines', or 'aliases'.",
2092 })).unwrap_or(Ok(()))
2094 ($key_name:ident, RelocModel) => ( {
2095 let name = (stringify!($key_name)).replace("_", "-");
2096 obj.remove(&name).and_then(|o| o.as_str().and_then(|s| {
2097 match s.parse::<RelocModel>() {
2098 Ok(relocation_model) => base.$key_name = relocation_model,
2099 _ => return Some(Err(format!("'{}' is not a valid relocation model. \
2100 Run `rustc --print relocation-models` to \
2101 see the list of supported values.", s))),
2104 })).unwrap_or(Ok(()))
2106 ($key_name:ident, CodeModel) => ( {
2107 let name = (stringify!($key_name)).replace("_", "-");
2108 obj.remove(&name).and_then(|o| o.as_str().and_then(|s| {
2109 match s.parse::<CodeModel>() {
2110 Ok(code_model) => base.$key_name = Some(code_model),
2111 _ => return Some(Err(format!("'{}' is not a valid code model. \
2112 Run `rustc --print code-models` to \
2113 see the list of supported values.", s))),
2116 })).unwrap_or(Ok(()))
2118 ($key_name:ident, TlsModel) => ( {
2119 let name = (stringify!($key_name)).replace("_", "-");
2120 obj.remove(&name).and_then(|o| o.as_str().and_then(|s| {
2121 match s.parse::<TlsModel>() {
2122 Ok(tls_model) => base.$key_name = tls_model,
2123 _ => return Some(Err(format!("'{}' is not a valid TLS model. \
2124 Run `rustc --print tls-models` to \
2125 see the list of supported values.", s))),
2128 })).unwrap_or(Ok(()))
2130 ($key_name:ident, PanicStrategy) => ( {
2131 let name = (stringify!($key_name)).replace("_", "-");
2132 obj.remove(&name).and_then(|o| o.as_str().and_then(|s| {
2134 "unwind" => base.$key_name = PanicStrategy::Unwind,
2135 "abort" => base.$key_name = PanicStrategy::Abort,
2136 _ => return Some(Err(format!("'{}' is not a valid value for \
2137 panic-strategy. Use 'unwind' or 'abort'.",
2141 })).unwrap_or(Ok(()))
2143 ($key_name:ident, RelroLevel) => ( {
2144 let name = (stringify!($key_name)).replace("_", "-");
2145 obj.remove(&name).and_then(|o| o.as_str().and_then(|s| {
2146 match s.parse::<RelroLevel>() {
2147 Ok(level) => base.$key_name = level,
2148 _ => return Some(Err(format!("'{}' is not a valid value for \
2149 relro-level. Use 'full', 'partial, or 'off'.",
2153 })).unwrap_or(Ok(()))
2155 ($key_name:ident, DebuginfoKind) => ( {
2156 let name = (stringify!($key_name)).replace("_", "-");
2157 obj.remove(&name).and_then(|o| o.as_str().and_then(|s| {
2158 match s.parse::<DebuginfoKind>() {
2159 Ok(level) => base.$key_name = level,
2160 _ => return Some(Err(
2161 format!("'{s}' is not a valid value for debuginfo-kind. Use 'dwarf', \
2162 'dwarf-dsym' or 'pdb'.")
2166 })).unwrap_or(Ok(()))
2168 ($key_name:ident, SplitDebuginfo) => ( {
2169 let name = (stringify!($key_name)).replace("_", "-");
2170 obj.remove(&name).and_then(|o| o.as_str().and_then(|s| {
2171 match s.parse::<SplitDebuginfo>() {
2172 Ok(level) => base.$key_name = level,
2173 _ => return Some(Err(format!("'{}' is not a valid value for \
2174 split-debuginfo. Use 'off' or 'dsymutil'.",
2178 })).unwrap_or(Ok(()))
2180 ($key_name:ident, list) => ( {
2181 let name = (stringify!($key_name)).replace("_", "-");
2182 if let Some(j) = obj.remove(&name) {
2183 if let Some(v) = j.as_array() {
2184 base.$key_name = v.iter()
2185 .map(|a| a.as_str().unwrap().to_string().into())
2188 incorrect_type.push(name)
2192 ($key_name:ident, opt_list) => ( {
2193 let name = (stringify!($key_name)).replace("_", "-");
2194 if let Some(j) = obj.remove(&name) {
2195 if let Some(v) = j.as_array() {
2196 base.$key_name = Some(v.iter()
2197 .map(|a| a.as_str().unwrap().to_string().into())
2200 incorrect_type.push(name)
2204 ($key_name:ident, falliable_list) => ( {
2205 let name = (stringify!($key_name)).replace("_", "-");
2206 obj.remove(&name).and_then(|j| {
2207 if let Some(v) = j.as_array() {
2208 match v.iter().map(|a| FromStr::from_str(a.as_str().unwrap())).collect() {
2209 Ok(l) => { base.$key_name = l },
2210 // FIXME: `falliable_list` can't re-use the `key!` macro for list
2211 // elements and the error messages from that macro, so it has a bad
2212 // generic message instead
2213 Err(_) => return Some(Err(
2214 format!("`{:?}` is not a valid value for `{}`", j, name)
2218 incorrect_type.push(name)
2221 }).unwrap_or(Ok(()))
2223 ($key_name:ident, optional) => ( {
2224 let name = (stringify!($key_name)).replace("_", "-");
2225 if let Some(o) = obj.remove(&name) {
2228 .map(|s| s.to_string().into());
2231 ($key_name:ident = $json_name:expr, LldFlavor) => ( {
2232 let name = $json_name;
2233 obj.remove(name).and_then(|o| o.as_str().and_then(|s| {
2234 if let Some(flavor) = LldFlavor::from_str(&s) {
2235 base.$key_name = flavor;
2237 return Some(Err(format!(
2238 "'{}' is not a valid value for lld-flavor. \
2239 Use 'darwin', 'gnu', 'link' or 'wasm.",
2243 })).unwrap_or(Ok(()))
2245 ($key_name:ident = $json_name:expr, LinkerFlavor) => ( {
2246 let name = $json_name;
2247 obj.remove(name).and_then(|o| o.as_str().and_then(|s| {
2248 match LinkerFlavorCli::from_str(s) {
2249 Some(linker_flavor) => base.$key_name = linker_flavor,
2250 _ => return Some(Err(format!("'{}' is not a valid value for linker-flavor. \
2251 Use {}", s, LinkerFlavorCli::one_of()))),
2254 })).unwrap_or(Ok(()))
2256 ($key_name:ident, StackProbeType) => ( {
2257 let name = (stringify!($key_name)).replace("_", "-");
2258 obj.remove(&name).and_then(|o| match StackProbeType::from_json(&o) {
2264 format!("`{:?}` is not a valid value for `{}`: {}", o, name, s)
2266 }).unwrap_or(Ok(()))
2268 ($key_name:ident, SanitizerSet) => ( {
2269 let name = (stringify!($key_name)).replace("_", "-");
2270 if let Some(o) = obj.remove(&name) {
2271 if let Some(a) = o.as_array() {
2273 base.$key_name |= match s.as_str() {
2274 Some("address") => SanitizerSet::ADDRESS,
2275 Some("cfi") => SanitizerSet::CFI,
2276 Some("leak") => SanitizerSet::LEAK,
2277 Some("memory") => SanitizerSet::MEMORY,
2278 Some("memtag") => SanitizerSet::MEMTAG,
2279 Some("shadow-call-stack") => SanitizerSet::SHADOWCALLSTACK,
2280 Some("thread") => SanitizerSet::THREAD,
2281 Some("hwaddress") => SanitizerSet::HWADDRESS,
2282 Some(s) => return Err(format!("unknown sanitizer {}", s)),
2283 _ => return Err(format!("not a string: {:?}", s)),
2287 incorrect_type.push(name)
2290 Ok::<(), String>(())
2293 ($key_name:ident = $json_name:expr, link_self_contained) => ( {
2294 let name = $json_name;
2295 obj.remove(name).and_then(|o| o.as_str().and_then(|s| {
2296 match s.parse::<LinkSelfContainedDefault>() {
2297 Ok(lsc_default) => base.$key_name = lsc_default,
2298 _ => return Some(Err(format!("'{}' is not a valid `-Clink-self-contained` default. \
2299 Use 'false', 'true', 'musl' or 'mingw'", s))),
2302 })).unwrap_or(Ok(()))
2304 ($key_name:ident = $json_name:expr, link_objects) => ( {
2305 let name = $json_name;
2306 if let Some(val) = obj.remove(name) {
2307 let obj = val.as_object().ok_or_else(|| format!("{}: expected a \
2308 JSON object with fields per CRT object kind.", name))?;
2309 let mut args = CrtObjects::new();
2311 let kind = LinkOutputKind::from_str(&k).ok_or_else(|| {
2312 format!("{}: '{}' is not a valid value for CRT object kind. \
2313 Use '(dynamic,static)-(nopic,pic)-exe' or \
2314 '(dynamic,static)-dylib' or 'wasi-reactor-exe'", name, k)
2317 let v = v.as_array().ok_or_else(||
2318 format!("{}.{}: expected a JSON array", name, k)
2319 )?.iter().enumerate()
2321 let s = s.as_str().ok_or_else(||
2322 format!("{}.{}[{}]: expected a JSON string", name, k, i))?;
2323 Ok(s.to_string().into())
2325 .collect::<Result<Vec<_>, String>>()?;
2327 args.insert(kind, v);
2329 base.$key_name = args;
2332 ($key_name:ident = $json_name:expr, link_args) => ( {
2333 let name = $json_name;
2334 if let Some(val) = obj.remove(name) {
2335 let obj = val.as_object().ok_or_else(|| format!("{}: expected a \
2336 JSON object with fields per linker-flavor.", name))?;
2337 let mut args = LinkArgsCli::new();
2339 let flavor = LinkerFlavorCli::from_str(&k).ok_or_else(|| {
2340 format!("{}: '{}' is not a valid value for linker-flavor. \
2341 Use 'em', 'gcc', 'ld' or 'msvc'", name, k)
2344 let v = v.as_array().ok_or_else(||
2345 format!("{}.{}: expected a JSON array", name, k)
2346 )?.iter().enumerate()
2348 let s = s.as_str().ok_or_else(||
2349 format!("{}.{}[{}]: expected a JSON string", name, k, i))?;
2350 Ok(s.to_string().into())
2352 .collect::<Result<Vec<_>, String>>()?;
2354 args.insert(flavor, v);
2356 base.$key_name = args;
2359 ($key_name:ident, env) => ( {
2360 let name = (stringify!($key_name)).replace("_", "-");
2361 if let Some(o) = obj.remove(&name) {
2362 if let Some(a) = o.as_array() {
2364 if let Some(s) = o.as_str() {
2365 let p = s.split('=').collect::<Vec<_>>();
2367 let k = p[0].to_string();
2368 let v = p[1].to_string();
2369 base.$key_name.to_mut().push((k.into(), v.into()));
2374 incorrect_type.push(name)
2378 ($key_name:ident, Option<Abi>) => ( {
2379 let name = (stringify!($key_name)).replace("_", "-");
2380 obj.remove(&name).and_then(|o| o.as_str().and_then(|s| {
2381 match lookup_abi(s) {
2382 Some(abi) => base.$key_name = Some(abi),
2383 _ => return Some(Err(format!("'{}' is not a valid value for abi", s))),
2386 })).unwrap_or(Ok(()))
2388 ($key_name:ident, TargetFamilies) => ( {
2389 if let Some(value) = obj.remove("target-family") {
2390 if let Some(v) = value.as_array() {
2391 base.$key_name = v.iter()
2392 .map(|a| a.as_str().unwrap().to_string().into())
2394 } else if let Some(v) = value.as_str() {
2395 base.$key_name = vec![v.to_string().into()].into();
2401 if let Some(j) = obj.remove("target-endian") {
2402 if let Some(s) = j.as_str() {
2403 base.endian = s.parse()?;
2405 incorrect_type.push("target-endian".into())
2409 if let Some(fp) = obj.remove("frame-pointer") {
2410 if let Some(s) = fp.as_str() {
2411 base.frame_pointer = s
2413 .map_err(|()| format!("'{}' is not a valid value for frame-pointer", s))?;
2415 incorrect_type.push("frame-pointer".into())
2419 key!(is_builtin, bool);
2420 key!(c_int_width = "target-c-int-width");
2425 key!(linker, optional);
2426 key!(linker_flavor_json = "linker-flavor", LinkerFlavor)?;
2427 key!(lld_flavor_json = "lld-flavor", LldFlavor)?;
2428 key!(linker_is_gnu_json = "linker-is-gnu", bool);
2429 key!(pre_link_objects = "pre-link-objects", link_objects);
2430 key!(post_link_objects = "post-link-objects", link_objects);
2431 key!(pre_link_objects_self_contained = "pre-link-objects-fallback", link_objects);
2432 key!(post_link_objects_self_contained = "post-link-objects-fallback", link_objects);
2433 key!(link_self_contained = "crt-objects-fallback", link_self_contained)?;
2434 key!(pre_link_args_json = "pre-link-args", link_args);
2435 key!(late_link_args_json = "late-link-args", link_args);
2436 key!(late_link_args_dynamic_json = "late-link-args-dynamic", link_args);
2437 key!(late_link_args_static_json = "late-link-args-static", link_args);
2438 key!(post_link_args_json = "post-link-args", link_args);
2439 key!(link_script, optional);
2440 key!(link_env, env);
2441 key!(link_env_remove, list);
2442 key!(asm_args, list);
2445 key!(dynamic_linking, bool);
2446 key!(only_cdylib, bool);
2447 key!(executables, bool);
2448 key!(relocation_model, RelocModel)?;
2449 key!(code_model, CodeModel)?;
2450 key!(tls_model, TlsModel)?;
2451 key!(disable_redzone, bool);
2452 key!(function_sections, bool);
2456 key!(staticlib_prefix);
2457 key!(staticlib_suffix);
2458 key!(families, TargetFamilies);
2459 key!(abi_return_struct_as_int, bool);
2460 key!(is_like_osx, bool);
2461 key!(is_like_solaris, bool);
2462 key!(is_like_windows, bool);
2463 key!(is_like_msvc, bool);
2464 key!(is_like_wasm, bool);
2465 key!(is_like_android, bool);
2466 key!(default_dwarf_version, u32);
2467 key!(allows_weak_linkage, bool);
2468 key!(has_rpath, bool);
2469 key!(no_default_libraries, bool);
2470 key!(position_independent_executables, bool);
2471 key!(static_position_independent_executables, bool);
2472 key!(needs_plt, bool);
2473 key!(relro_level, RelroLevel)?;
2474 key!(archive_format);
2475 key!(allow_asm, bool);
2476 key!(main_needs_argc_argv, bool);
2477 key!(has_thread_local, bool);
2478 key!(obj_is_bitcode, bool);
2479 key!(forces_embed_bitcode, bool);
2480 key!(bitcode_llvm_cmdline);
2481 key!(max_atomic_width, Option<u64>);
2482 key!(min_atomic_width, Option<u64>);
2483 key!(atomic_cas, bool);
2484 key!(panic_strategy, PanicStrategy)?;
2485 key!(crt_static_allows_dylibs, bool);
2486 key!(crt_static_default, bool);
2487 key!(crt_static_respected, bool);
2488 key!(stack_probes, StackProbeType)?;
2489 key!(min_global_align, Option<u64>);
2490 key!(default_codegen_units, Option<u64>);
2491 key!(trap_unreachable, bool);
2492 key!(requires_lto, bool);
2493 key!(singlethread, bool);
2494 key!(no_builtins, bool);
2495 key!(default_hidden_visibility, bool);
2496 key!(emit_debug_gdb_scripts, bool);
2497 key!(requires_uwtable, bool);
2498 key!(default_uwtable, bool);
2499 key!(simd_types_indirect, bool);
2500 key!(limit_rdylib_exports, bool);
2501 key!(override_export_symbols, opt_list);
2502 key!(merge_functions, MergeFunctions)?;
2503 key!(mcount = "target-mcount");
2505 key!(relax_elf_relocations, bool);
2506 key!(llvm_args, list);
2507 key!(use_ctors_section, bool);
2508 key!(eh_frame_header, bool);
2509 key!(has_thumb_interworking, bool);
2510 key!(debuginfo_kind, DebuginfoKind)?;
2511 key!(split_debuginfo, SplitDebuginfo)?;
2512 key!(supported_split_debuginfo, falliable_list)?;
2513 key!(supported_sanitizers, SanitizerSet)?;
2514 key!(default_adjusted_cabi, Option<Abi>)?;
2515 key!(c_enum_min_bits, u64);
2516 key!(generate_arange_section, bool);
2517 key!(supports_stack_protector, bool);
2519 if base.is_builtin {
2520 // This can cause unfortunate ICEs later down the line.
2521 return Err("may not set is_builtin for targets not built-in".into());
2523 base.update_from_cli();
2525 // Each field should have been read using `Json::remove` so any keys remaining are unused.
2526 let remaining_keys = obj.keys();
2529 TargetWarnings { unused_fields: remaining_keys.cloned().collect(), incorrect_type },
2533 /// Load a built-in target
2534 pub fn expect_builtin(target_triple: &TargetTriple) -> Target {
2535 match *target_triple {
2536 TargetTriple::TargetTriple(ref target_triple) => {
2537 load_builtin(target_triple).expect("built-in target")
2539 TargetTriple::TargetJson { .. } => {
2540 panic!("built-in targets doesn't support target-paths")
2545 /// Search for a JSON file specifying the given target triple.
2547 /// If none is found in `$RUST_TARGET_PATH`, look for a file called `target.json` inside the
2548 /// sysroot under the target-triple's `rustlib` directory. Note that it could also just be a
2549 /// bare filename already, so also check for that. If one of the hardcoded targets we know
2550 /// about, just return it directly.
2552 /// The error string could come from any of the APIs called, including filesystem access and
2555 target_triple: &TargetTriple,
2557 ) -> Result<(Target, TargetWarnings), String> {
2561 fn load_file(path: &Path) -> Result<(Target, TargetWarnings), String> {
2562 let contents = fs::read_to_string(path).map_err(|e| e.to_string())?;
2563 let obj = serde_json::from_str(&contents).map_err(|e| e.to_string())?;
2564 Target::from_json(obj)
2567 match *target_triple {
2568 TargetTriple::TargetTriple(ref target_triple) => {
2569 // check if triple is in list of built-in targets
2570 if let Some(t) = load_builtin(target_triple) {
2571 return Ok((t, TargetWarnings::empty()));
2574 // search for a file named `target_triple`.json in RUST_TARGET_PATH
2576 let mut target = target_triple.to_string();
2577 target.push_str(".json");
2578 PathBuf::from(target)
2581 let target_path = env::var_os("RUST_TARGET_PATH").unwrap_or_default();
2583 for dir in env::split_paths(&target_path) {
2584 let p = dir.join(&path);
2586 return load_file(&p);
2590 // Additionally look in the sysroot under `lib/rustlib/<triple>/target.json`
2592 let rustlib_path = crate::target_rustlib_path(&sysroot, &target_triple);
2593 let p = PathBuf::from_iter([
2595 Path::new(&rustlib_path),
2596 Path::new("target.json"),
2599 return load_file(&p);
2602 Err(format!("Could not find specification for target {:?}", target_triple))
2604 TargetTriple::TargetJson { ref contents, .. } => {
2605 let obj = serde_json::from_str(contents).map_err(|e| e.to_string())?;
2606 Target::from_json(obj)
2612 impl ToJson for Target {
2613 fn to_json(&self) -> Json {
2614 let mut d = serde_json::Map::new();
2615 let default: TargetOptions = Default::default();
2616 let mut target = self.clone();
2617 target.update_to_cli();
2619 macro_rules! target_val {
2621 let name = (stringify!($attr)).replace("_", "-");
2622 d.insert(name, target.$attr.to_json());
2626 macro_rules! target_option_val {
2628 let name = (stringify!($attr)).replace("_", "-");
2629 if default.$attr != target.$attr {
2630 d.insert(name, target.$attr.to_json());
2633 ($attr:ident, $json_name:expr) => {{
2634 let name = $json_name;
2635 if default.$attr != target.$attr {
2636 d.insert(name.into(), target.$attr.to_json());
2639 (link_args - $attr:ident, $json_name:expr) => {{
2640 let name = $json_name;
2641 if default.$attr != target.$attr {
2645 .map(|(k, v)| (k.desc().to_string(), v.clone()))
2646 .collect::<BTreeMap<_, _>>();
2647 d.insert(name.to_string(), obj.to_json());
2650 (env - $attr:ident) => {{
2651 let name = (stringify!($attr)).replace("_", "-");
2652 if default.$attr != target.$attr {
2656 .map(|&(ref k, ref v)| format!("{k}={v}"))
2657 .collect::<Vec<_>>();
2658 d.insert(name, obj.to_json());
2663 target_val!(llvm_target);
2664 d.insert("target-pointer-width".to_string(), self.pointer_width.to_string().to_json());
2666 target_val!(data_layout);
2668 target_option_val!(is_builtin);
2669 target_option_val!(endian, "target-endian");
2670 target_option_val!(c_int_width, "target-c-int-width");
2671 target_option_val!(os);
2672 target_option_val!(env);
2673 target_option_val!(abi);
2674 target_option_val!(vendor);
2675 target_option_val!(linker);
2676 target_option_val!(linker_flavor_json, "linker-flavor");
2677 target_option_val!(lld_flavor_json, "lld-flavor");
2678 target_option_val!(linker_is_gnu_json, "linker-is-gnu");
2679 target_option_val!(pre_link_objects);
2680 target_option_val!(post_link_objects);
2681 target_option_val!(pre_link_objects_self_contained, "pre-link-objects-fallback");
2682 target_option_val!(post_link_objects_self_contained, "post-link-objects-fallback");
2683 target_option_val!(link_self_contained, "crt-objects-fallback");
2684 target_option_val!(link_args - pre_link_args_json, "pre-link-args");
2685 target_option_val!(link_args - late_link_args_json, "late-link-args");
2686 target_option_val!(link_args - late_link_args_dynamic_json, "late-link-args-dynamic");
2687 target_option_val!(link_args - late_link_args_static_json, "late-link-args-static");
2688 target_option_val!(link_args - post_link_args_json, "post-link-args");
2689 target_option_val!(link_script);
2690 target_option_val!(env - link_env);
2691 target_option_val!(link_env_remove);
2692 target_option_val!(asm_args);
2693 target_option_val!(cpu);
2694 target_option_val!(features);
2695 target_option_val!(dynamic_linking);
2696 target_option_val!(only_cdylib);
2697 target_option_val!(executables);
2698 target_option_val!(relocation_model);
2699 target_option_val!(code_model);
2700 target_option_val!(tls_model);
2701 target_option_val!(disable_redzone);
2702 target_option_val!(frame_pointer);
2703 target_option_val!(function_sections);
2704 target_option_val!(dll_prefix);
2705 target_option_val!(dll_suffix);
2706 target_option_val!(exe_suffix);
2707 target_option_val!(staticlib_prefix);
2708 target_option_val!(staticlib_suffix);
2709 target_option_val!(families, "target-family");
2710 target_option_val!(abi_return_struct_as_int);
2711 target_option_val!(is_like_osx);
2712 target_option_val!(is_like_solaris);
2713 target_option_val!(is_like_windows);
2714 target_option_val!(is_like_msvc);
2715 target_option_val!(is_like_wasm);
2716 target_option_val!(is_like_android);
2717 target_option_val!(default_dwarf_version);
2718 target_option_val!(allows_weak_linkage);
2719 target_option_val!(has_rpath);
2720 target_option_val!(no_default_libraries);
2721 target_option_val!(position_independent_executables);
2722 target_option_val!(static_position_independent_executables);
2723 target_option_val!(needs_plt);
2724 target_option_val!(relro_level);
2725 target_option_val!(archive_format);
2726 target_option_val!(allow_asm);
2727 target_option_val!(main_needs_argc_argv);
2728 target_option_val!(has_thread_local);
2729 target_option_val!(obj_is_bitcode);
2730 target_option_val!(forces_embed_bitcode);
2731 target_option_val!(bitcode_llvm_cmdline);
2732 target_option_val!(min_atomic_width);
2733 target_option_val!(max_atomic_width);
2734 target_option_val!(atomic_cas);
2735 target_option_val!(panic_strategy);
2736 target_option_val!(crt_static_allows_dylibs);
2737 target_option_val!(crt_static_default);
2738 target_option_val!(crt_static_respected);
2739 target_option_val!(stack_probes);
2740 target_option_val!(min_global_align);
2741 target_option_val!(default_codegen_units);
2742 target_option_val!(trap_unreachable);
2743 target_option_val!(requires_lto);
2744 target_option_val!(singlethread);
2745 target_option_val!(no_builtins);
2746 target_option_val!(default_hidden_visibility);
2747 target_option_val!(emit_debug_gdb_scripts);
2748 target_option_val!(requires_uwtable);
2749 target_option_val!(default_uwtable);
2750 target_option_val!(simd_types_indirect);
2751 target_option_val!(limit_rdylib_exports);
2752 target_option_val!(override_export_symbols);
2753 target_option_val!(merge_functions);
2754 target_option_val!(mcount, "target-mcount");
2755 target_option_val!(llvm_abiname);
2756 target_option_val!(relax_elf_relocations);
2757 target_option_val!(llvm_args);
2758 target_option_val!(use_ctors_section);
2759 target_option_val!(eh_frame_header);
2760 target_option_val!(has_thumb_interworking);
2761 target_option_val!(debuginfo_kind);
2762 target_option_val!(split_debuginfo);
2763 target_option_val!(supported_split_debuginfo);
2764 target_option_val!(supported_sanitizers);
2765 target_option_val!(c_enum_min_bits);
2766 target_option_val!(generate_arange_section);
2767 target_option_val!(supports_stack_protector);
2769 if let Some(abi) = self.default_adjusted_cabi {
2770 d.insert("default-adjusted-cabi".into(), Abi::name(abi).to_json());
2777 /// Either a target triple string or a path to a JSON file.
2778 #[derive(Clone, Debug)]
2779 pub enum TargetTriple {
2780 TargetTriple(String),
2782 /// Warning: This field may only be used by rustdoc. Using it anywhere else will lead to
2783 /// inconsistencies as it is discarded during serialization.
2784 path_for_rustdoc: PathBuf,
2790 // Use a manual implementation to ignore the path field
2791 impl PartialEq for TargetTriple {
2792 fn eq(&self, other: &Self) -> bool {
2793 match (self, other) {
2794 (Self::TargetTriple(l0), Self::TargetTriple(r0)) => l0 == r0,
2796 Self::TargetJson { path_for_rustdoc: _, triple: l_triple, contents: l_contents },
2797 Self::TargetJson { path_for_rustdoc: _, triple: r_triple, contents: r_contents },
2798 ) => l_triple == r_triple && l_contents == r_contents,
2804 // Use a manual implementation to ignore the path field
2805 impl Hash for TargetTriple {
2806 fn hash<H: Hasher>(&self, state: &mut H) -> () {
2808 TargetTriple::TargetTriple(triple) => {
2812 TargetTriple::TargetJson { path_for_rustdoc: _, triple, contents } => {
2815 contents.hash(state)
2821 // Use a manual implementation to prevent encoding the target json file path in the crate metadata
2822 impl<S: Encoder> Encodable<S> for TargetTriple {
2823 fn encode(&self, s: &mut S) {
2825 TargetTriple::TargetTriple(triple) => s.emit_enum_variant(0, |s| s.emit_str(triple)),
2826 TargetTriple::TargetJson { path_for_rustdoc: _, triple, contents } => s
2827 .emit_enum_variant(1, |s| {
2829 s.emit_str(contents)
2835 impl<D: Decoder> Decodable<D> for TargetTriple {
2836 fn decode(d: &mut D) -> Self {
2837 match d.read_usize() {
2838 0 => TargetTriple::TargetTriple(d.read_str().to_owned()),
2839 1 => TargetTriple::TargetJson {
2840 path_for_rustdoc: PathBuf::new(),
2841 triple: d.read_str().to_owned(),
2842 contents: d.read_str().to_owned(),
2845 panic!("invalid enum variant tag while decoding `TargetTriple`, expected 0..2");
2852 /// Creates a target triple from the passed target triple string.
2853 pub fn from_triple(triple: &str) -> Self {
2854 TargetTriple::TargetTriple(triple.into())
2857 /// Creates a target triple from the passed target path.
2858 pub fn from_path(path: &Path) -> Result<Self, io::Error> {
2859 let canonicalized_path = path.canonicalize()?;
2860 let contents = std::fs::read_to_string(&canonicalized_path).map_err(|err| {
2862 io::ErrorKind::InvalidInput,
2863 format!("target path {:?} is not a valid file: {}", canonicalized_path, err),
2866 let triple = canonicalized_path
2868 .expect("target path must not be empty")
2870 .expect("target path must be valid unicode")
2872 Ok(TargetTriple::TargetJson { path_for_rustdoc: canonicalized_path, triple, contents })
2875 /// Returns a string triple for this target.
2877 /// If this target is a path, the file name (without extension) is returned.
2878 pub fn triple(&self) -> &str {
2880 TargetTriple::TargetTriple(ref triple)
2881 | TargetTriple::TargetJson { ref triple, .. } => triple,
2885 /// Returns an extended string triple for this target.
2887 /// If this target is a path, a hash of the path is appended to the triple returned
2889 pub fn debug_triple(&self) -> String {
2890 use std::collections::hash_map::DefaultHasher;
2893 TargetTriple::TargetTriple(triple) => triple.to_owned(),
2894 TargetTriple::TargetJson { path_for_rustdoc: _, triple, contents: content } => {
2895 let mut hasher = DefaultHasher::new();
2896 content.hash(&mut hasher);
2897 let hash = hasher.finish();
2898 format!("{}-{}", triple, hash)
2904 impl fmt::Display for TargetTriple {
2905 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2906 write!(f, "{}", self.debug_triple())