[go: up one dir, main page]

cc/
lib.rs

1//! A library for [Cargo build scripts](https://doc.rust-lang.org/cargo/reference/build-scripts.html)
2//! to compile a set of C/C++/assembly/CUDA files into a static archive for Cargo
3//! to link into the crate being built. This crate does not compile code itself;
4//! it calls out to the default compiler for the platform. This crate will
5//! automatically detect situations such as cross compilation and
6//! [various environment variables](#external-configuration-via-environment-variables) and will build code appropriately.
7//!
8//! # Example
9//!
10//! First, you'll want to both add a build script for your crate (`build.rs`) and
11//! also add this crate to your `Cargo.toml` via:
12//!
13//! ```toml
14//! [build-dependencies]
15//! cc = "1.0"
16//! ```
17//!
18//! Next up, you'll want to write a build script like so:
19//!
20//! ```rust,no_run
21//! // build.rs
22//! cc::Build::new()
23//!     .file("foo.c")
24//!     .file("bar.c")
25//!     .compile("foo");
26//! ```
27//!
28//! And that's it! Running `cargo build` should take care of the rest and your Rust
29//! application will now have the C files `foo.c` and `bar.c` compiled into a file
30//! named `libfoo.a`. If the C files contain
31//!
32//! ```c
33//! void foo_function(void) { ... }
34//! ```
35//!
36//! and
37//!
38//! ```c
39//! int32_t bar_function(int32_t x) { ... }
40//! ```
41//!
42//! you can call them from Rust by declaring them in
43//! your Rust code like so:
44//!
45//! ```rust,no_run
46//! extern "C" {
47//!     fn foo_function();
48//!     fn bar_function(x: i32) -> i32;
49//! }
50//!
51//! pub fn call() {
52//!     unsafe {
53//!         foo_function();
54//!         bar_function(42);
55//!     }
56//! }
57//!
58//! fn main() {
59//!     call();
60//! }
61//! ```
62//!
63//! See [the Rustonomicon](https://doc.rust-lang.org/nomicon/ffi.html) for more details.
64//!
65//! # External configuration via environment variables
66//!
67//! To control the programs and flags used for building, the builder can set a
68//! number of different environment variables.
69//!
70//! * `CFLAGS` - a series of space separated flags passed to compilers. Note that
71//!   individual flags cannot currently contain spaces, so doing
72//!   something like: `-L=foo\ bar` is not possible.
73//! * `CC` - the actual C compiler used. Note that this is used as an exact
74//!   executable name, so (for example) no extra flags can be passed inside
75//!   this variable, and the builder must ensure that there aren't any
76//!   trailing spaces. This compiler must understand the `-c` flag. For
77//!   certain `TARGET`s, it also is assumed to know about other flags (most
78//!   common is `-fPIC`).
79//!   ccache, distcc, sccache, icecc, cachepot and buildcache are supported,
80//!   for sccache, simply set `CC` to `sccache cc`.
81//!   For other custom `CC` wrapper, just set `CC_KNOWN_WRAPPER_CUSTOM`
82//!   to the custom wrapper used in `CC`.
83//! * `AR` - the `ar` (archiver) executable to use to build the static library.
84//! * `CRATE_CC_NO_DEFAULTS` - the default compiler flags may cause conflicts in
85//!   some cross compiling scenarios. Setting this variable
86//!   will disable the generation of default compiler
87//!   flags.
88//! * `CC_ENABLE_DEBUG_OUTPUT` - if set, compiler command invocations and exit codes will
89//!   be logged to stdout. This is useful for debugging build script issues, but can be
90//!   overly verbose for normal use.
91//! * `CC_SHELL_ESCAPED_FLAGS` - if set, `*FLAGS` will be parsed as if they were shell
92//!   arguments (similar to `make` and `cmake`) rather than splitting them on each space.
93//!   For example, with `CFLAGS='a "b c"'`, the compiler will be invoked with 2 arguments -
94//!   `a` and `b c` - rather than 3: `a`, `"b` and `c"`.
95//! * `CXX...` - see [C++ Support](#c-support).
96//! * `CC_FORCE_DISABLE` - If set, `cc` will never run any [`Command`]s, and methods that
97//!   would return an [`Error`]. This is intended for use by third-party build systems
98//!   which want to be absolutely sure that they are in control of building all
99//!   dependencies. Note that operations that return [`Tool`]s such as
100//!   [`Build::get_compiler`] may produce less accurate results as in some cases `cc` runs
101//!   commands in order to locate compilers. Additionally, this does nothing to prevent
102//!   users from running [`Tool::to_command`] and executing the [`Command`] themselves.
103//! * `RUSTC_WRAPPER` - If set, the specified command will be prefixed to the compiler
104//!   command. This is useful for projects that want to use
105//!   [sccache](https://github.com/mozilla/sccache),
106//!   [buildcache](https://gitlab.com/bits-n-bites/buildcache), or
107//!   [cachepot](https://github.com/paritytech/cachepot).
108//!
109//! Furthermore, projects using this crate may specify custom environment variables
110//! to be inspected, for example via the `Build::try_flags_from_environment`
111//! function. Consult the project’s own documentation or its use of the `cc` crate
112//! for any additional variables it may use.
113//!
114//! Each of these variables can also be supplied with certain prefixes and suffixes,
115//! in the following prioritized order:
116//!
117//!   1. `<var>_<target>` - for example, `CC_x86_64-unknown-linux-gnu` or `CC_thumbv8m.main-none-eabi`
118//!   2. `<var>_<target_with_underscores>` - for example, `CC_x86_64_unknown_linux_gnu` or `CC_thumbv8m_main_none_eabi` (both periods and underscores are replaced)
119//!   3. `<build-kind>_<var>` - for example, `HOST_CC` or `TARGET_CFLAGS`
120//!   4. `<var>` - a plain `CC`, `AR` as above.
121//!
122//! If none of these variables exist, cc-rs uses built-in defaults.
123//!
124//! In addition to the above optional environment variables, `cc-rs` has some
125//! functions with hard requirements on some variables supplied by [cargo's
126//! build-script driver][cargo] that it has the `TARGET`, `OUT_DIR`, `OPT_LEVEL`,
127//! and `HOST` variables.
128//!
129//! [cargo]: https://doc.rust-lang.org/cargo/reference/build-scripts.html#inputs-to-the-build-script
130//!
131//! # Optional features
132//!
133//! ## Parallel
134//!
135//! Currently cc-rs supports parallel compilation (think `make -jN`) but this
136//! feature is turned off by default. To enable cc-rs to compile C/C++ in parallel,
137//! you can change your dependency to:
138//!
139//! ```toml
140//! [build-dependencies]
141//! cc = { version = "1.0", features = ["parallel"] }
142//! ```
143//!
144//! By default cc-rs will limit parallelism to `$NUM_JOBS`, or if not present it
145//! will limit it to the number of cpus on the machine. If you are using cargo,
146//! use `-jN` option of `build`, `test` and `run` commands as `$NUM_JOBS`
147//! is supplied by cargo.
148//!
149//! # Compile-time Requirements
150//!
151//! To work properly this crate needs access to a C compiler when the build script
152//! is being run. This crate does not ship a C compiler with it. The compiler
153//! required varies per platform, but there are three broad categories:
154//!
155//! * Unix platforms require `cc` to be the C compiler. This can be found by
156//!   installing cc/clang on Linux distributions and Xcode on macOS, for example.
157//! * Windows platforms targeting MSVC (e.g. your target name ends in `-msvc`)
158//!   require Visual Studio to be installed. `cc-rs` attempts to locate it, and
159//!   if it fails, `cl.exe` is expected to be available in `PATH`. This can be
160//!   set up by running the appropriate developer tools shell.
161//! * Windows platforms targeting MinGW (e.g. your target name ends in `-gnu`)
162//!   require `cc` to be available in `PATH`. We recommend the
163//!   [MinGW-w64](https://www.mingw-w64.org/) distribution.
164//!   You may also acquire it via
165//!   [MSYS2](https://www.msys2.org/), as explained [here][msys2-help].  Make sure
166//!   to install the appropriate architecture corresponding to your installation of
167//!   rustc. GCC from older [MinGW](http://www.mingw.org/) project is compatible
168//!   only with 32-bit rust compiler.
169//!
170//! [msys2-help]: https://github.com/rust-lang/rust/blob/master/INSTALL.md#building-on-windows
171//!
172//! # C++ support
173//!
174//! `cc-rs` supports C++ libraries compilation by using the `cpp` method on
175//! `Build`:
176//!
177//! ```rust,no_run
178//! cc::Build::new()
179//!     .cpp(true) // Switch to C++ library compilation.
180//!     .file("foo.cpp")
181//!     .compile("foo");
182//! ```
183//!
184//! For C++ libraries, the `CXX` and `CXXFLAGS` environment variables are used instead of `CC` and `CFLAGS`.
185//!
186//! The C++ standard library may be linked to the crate target. By default it's `libc++` for macOS, FreeBSD, and OpenBSD, `libc++_shared` for Android, nothing for MSVC, and `libstdc++` for anything else. It can be changed in one of two ways:
187//!
188//! 1. by using the `cpp_link_stdlib` method on `Build`:
189//! ```rust,no_run
190//! cc::Build::new()
191//!     .cpp(true)
192//!     .file("foo.cpp")
193//!     .cpp_link_stdlib("stdc++") // use libstdc++
194//!     .compile("foo");
195//! ```
196//! 2. by setting the `CXXSTDLIB` environment variable.
197//!
198//! In particular, for Android you may want to [use `c++_static` if you have at most one shared library](https://developer.android.com/ndk/guides/cpp-support).
199//!
200//! Remember that C++ does name mangling so `extern "C"` might be required to enable Rust linker to find your functions.
201//!
202//! # CUDA C++ support
203//!
204//! `cc-rs` also supports compiling CUDA C++ libraries by using the `cuda` method
205//! on `Build`:
206//!
207//! ```rust,no_run
208//! cc::Build::new()
209//!     // Switch to CUDA C++ library compilation using NVCC.
210//!     .cuda(true)
211//!     .cudart("static")
212//!     // Generate code for Maxwell (GTX 970, 980, 980 Ti, Titan X).
213//!     .flag("-gencode").flag("arch=compute_52,code=sm_52")
214//!     // Generate code for Maxwell (Jetson TX1).
215//!     .flag("-gencode").flag("arch=compute_53,code=sm_53")
216//!     // Generate code for Pascal (GTX 1070, 1080, 1080 Ti, Titan Xp).
217//!     .flag("-gencode").flag("arch=compute_61,code=sm_61")
218//!     // Generate code for Pascal (Tesla P100).
219//!     .flag("-gencode").flag("arch=compute_60,code=sm_60")
220//!     // Generate code for Pascal (Jetson TX2).
221//!     .flag("-gencode").flag("arch=compute_62,code=sm_62")
222//!     // Generate code in parallel
223//!     .flag("-t0")
224//!     .file("bar.cu")
225//!     .compile("bar");
226//! ```
227//!
228//! # Speed up compilation with sccache
229//!
230//! `cc-rs` does not handle incremental compilation like `make` or `ninja`. It
231//! always compiles the all sources, no matter if they have changed or not.
232//! This would be time-consuming in large projects. To save compilation time,
233//! you can use [sccache](https://github.com/mozilla/sccache) by setting
234//! environment variable `RUSTC_WRAPPER=sccache`, which will use cached `.o`
235//! files if the sources are unchanged.
236
237#![doc(html_root_url = "https://docs.rs/cc/1.0")]
238#![deny(warnings)]
239#![deny(missing_docs)]
240#![deny(clippy::disallowed_methods)]
241#![warn(clippy::doc_markdown)]
242
243use std::borrow::Cow;
244use std::collections::HashMap;
245use std::env;
246use std::ffi::{OsStr, OsString};
247use std::fmt::{self, Display};
248use std::fs;
249use std::io::{self, Write};
250use std::path::{Component, Path, PathBuf};
251use std::process::{Command, Stdio};
252use std::sync::{
253    atomic::{AtomicU8, Ordering::Relaxed},
254    Arc, RwLock,
255};
256
257use shlex::Shlex;
258
259#[cfg(feature = "parallel")]
260mod parallel;
261
262mod target;
263use self::target::*;
264
265/// A helper module to looking for windows-specific tools:
266/// 1. On Windows host, probe the Windows Registry if needed;
267/// 2. On non-Windows host, check specified environment variables.
268pub mod windows_registry {
269    // Regardless of whether this should be in this crate's public API,
270    // it has been since 2015, so don't break it.
271
272    /// Attempts to find a tool within an MSVC installation using the Windows
273    /// registry as a point to search from.
274    ///
275    /// The `arch_or_target` argument is the architecture or the Rust target name
276    /// that the tool should work for (e.g. compile or link for). The supported
277    /// architecture names are:
278    /// - `"x64"` or `"x86_64"`
279    /// - `"arm64"` or `"aarch64"`
280    /// - `"arm64ec"`
281    /// - `"x86"`, `"i586"` or `"i686"`
282    /// - `"arm"` or `"thumbv7a"`
283    ///
284    /// The `tool` argument is the tool to find. Supported tools include:
285    /// - MSVC tools: `cl.exe`, `link.exe`, `lib.exe`, etc.
286    /// - `MSBuild`: `msbuild.exe`
287    /// - Visual Studio IDE: `devenv.exe`
288    /// - Clang/LLVM tools: `clang.exe`, `clang++.exe`, `clang-*.exe`, `llvm-*.exe`, `lld.exe`, etc.
289    ///
290    /// This function will return `None` if the tool could not be found, or it will
291    /// return `Some(cmd)` which represents a command that's ready to execute the
292    /// tool with the appropriate environment variables set.
293    ///
294    /// Note that this function always returns `None` for non-MSVC targets (if a
295    /// full target name was specified).
296    pub fn find(arch_or_target: &str, tool: &str) -> Option<std::process::Command> {
297        ::find_msvc_tools::find(arch_or_target, tool)
298    }
299
300    /// A version of Visual Studio
301    #[derive(Debug, PartialEq, Eq, Copy, Clone)]
302    #[non_exhaustive]
303    pub enum VsVers {
304        /// Visual Studio 12 (2013)
305        #[deprecated = "Visual Studio 12 is no longer supported. cc will never return this value."]
306        Vs12,
307        /// Visual Studio 14 (2015)
308        Vs14,
309        /// Visual Studio 15 (2017)
310        Vs15,
311        /// Visual Studio 16 (2019)
312        Vs16,
313        /// Visual Studio 17 (2022)
314        Vs17,
315    }
316
317    /// Find the most recent installed version of Visual Studio
318    ///
319    /// This is used by the cmake crate to figure out the correct
320    /// generator.
321    pub fn find_vs_version() -> Result<VsVers, String> {
322        ::find_msvc_tools::find_vs_version().map(|vers| match vers {
323            #[allow(deprecated)]
324            ::find_msvc_tools::VsVers::Vs12 => VsVers::Vs12,
325            ::find_msvc_tools::VsVers::Vs14 => VsVers::Vs14,
326            ::find_msvc_tools::VsVers::Vs15 => VsVers::Vs15,
327            ::find_msvc_tools::VsVers::Vs16 => VsVers::Vs16,
328            ::find_msvc_tools::VsVers::Vs17 => VsVers::Vs17,
329            _ => unreachable!("unknown VS version"),
330        })
331    }
332
333    /// Similar to the `find` function above, this function will attempt the same
334    /// operation (finding a MSVC tool in a local install) but instead returns a
335    /// [`Tool`](crate::Tool) which may be introspected.
336    pub fn find_tool(arch_or_target: &str, tool: &str) -> Option<crate::Tool> {
337        ::find_msvc_tools::find_tool(arch_or_target, tool).map(crate::Tool::from_find_msvc_tools)
338    }
339}
340
341mod command_helpers;
342use command_helpers::*;
343
344mod tool;
345pub use tool::Tool;
346use tool::{CompilerFamilyLookupCache, ToolFamily};
347
348mod tempfile;
349
350mod utilities;
351use utilities::*;
352
353mod flags;
354use flags::*;
355
356#[derive(Debug, Eq, PartialEq, Hash)]
357struct CompilerFlag {
358    compiler: Box<Path>,
359    flag: Box<OsStr>,
360}
361
362type Env = Option<Arc<OsStr>>;
363
364#[derive(Debug, Default)]
365struct BuildCache {
366    env_cache: RwLock<HashMap<Box<str>, Env>>,
367    apple_sdk_root_cache: RwLock<HashMap<Box<str>, Arc<OsStr>>>,
368    apple_versions_cache: RwLock<HashMap<Box<str>, Arc<str>>>,
369    cached_compiler_family: RwLock<CompilerFamilyLookupCache>,
370    known_flag_support_status_cache: RwLock<HashMap<CompilerFlag, bool>>,
371    target_info_parser: target::TargetInfoParser,
372}
373
374/// A builder for compilation of a native library.
375///
376/// A `Build` is the main type of the `cc` crate and is used to control all the
377/// various configuration options and such of a compile. You'll find more
378/// documentation on each method itself.
379#[derive(Clone, Debug)]
380pub struct Build {
381    include_directories: Vec<Arc<Path>>,
382    definitions: Vec<(Arc<str>, Option<Arc<str>>)>,
383    objects: Vec<Arc<Path>>,
384    flags: Vec<Arc<OsStr>>,
385    flags_supported: Vec<Arc<OsStr>>,
386    ar_flags: Vec<Arc<OsStr>>,
387    asm_flags: Vec<Arc<OsStr>>,
388    no_default_flags: bool,
389    files: Vec<Arc<Path>>,
390    cpp: bool,
391    cpp_link_stdlib: Option<Option<Arc<str>>>,
392    cpp_link_stdlib_static: bool,
393    cpp_set_stdlib: Option<Arc<str>>,
394    cuda: bool,
395    cudart: Option<Arc<str>>,
396    ccbin: bool,
397    std: Option<Arc<str>>,
398    target: Option<Arc<str>>,
399    /// The host compiler.
400    ///
401    /// Try to not access this directly, and instead prefer `cfg!(...)`.
402    host: Option<Arc<str>>,
403    out_dir: Option<Arc<Path>>,
404    opt_level: Option<Arc<str>>,
405    debug: Option<bool>,
406    force_frame_pointer: Option<bool>,
407    env: Vec<(Arc<OsStr>, Arc<OsStr>)>,
408    compiler: Option<Arc<Path>>,
409    archiver: Option<Arc<Path>>,
410    ranlib: Option<Arc<Path>>,
411    cargo_output: CargoOutput,
412    link_lib_modifiers: Vec<Arc<OsStr>>,
413    pic: Option<bool>,
414    use_plt: Option<bool>,
415    static_crt: Option<bool>,
416    shared_flag: Option<bool>,
417    static_flag: Option<bool>,
418    warnings_into_errors: bool,
419    warnings: Option<bool>,
420    extra_warnings: Option<bool>,
421    emit_rerun_if_env_changed: bool,
422    shell_escaped_flags: Option<bool>,
423    build_cache: Arc<BuildCache>,
424    inherit_rustflags: bool,
425    prefer_clang_cl_over_msvc: bool,
426}
427
428/// Represents the types of errors that may occur while using cc-rs.
429#[derive(Clone, Debug)]
430enum ErrorKind {
431    /// Error occurred while performing I/O.
432    IOError,
433    /// Environment variable not found, with the var in question as extra info.
434    EnvVarNotFound,
435    /// Error occurred while using external tools (ie: invocation of compiler).
436    ToolExecError,
437    /// Error occurred due to missing external tools.
438    ToolNotFound,
439    /// One of the function arguments failed validation.
440    InvalidArgument,
441    /// No known macro is defined for the compiler when discovering tool family.
442    ToolFamilyMacroNotFound,
443    /// Invalid target.
444    InvalidTarget,
445    /// Unknown target.
446    UnknownTarget,
447    /// Invalid rustc flag.
448    InvalidFlag,
449    #[cfg(feature = "parallel")]
450    /// jobserver helpthread failure
451    JobserverHelpThreadError,
452    /// `cc` has been disabled by an environment variable.
453    Disabled,
454}
455
456/// Represents an internal error that occurred, with an explanation.
457#[derive(Clone, Debug)]
458pub struct Error {
459    /// Describes the kind of error that occurred.
460    kind: ErrorKind,
461    /// More explanation of error that occurred.
462    message: Cow<'static, str>,
463}
464
465impl Error {
466    fn new(kind: ErrorKind, message: impl Into<Cow<'static, str>>) -> Error {
467        Error {
468            kind,
469            message: message.into(),
470        }
471    }
472}
473
474impl From<io::Error> for Error {
475    fn from(e: io::Error) -> Error {
476        Error::new(ErrorKind::IOError, format!("{e}"))
477    }
478}
479
480impl Display for Error {
481    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
482        write!(f, "{:?}: {}", self.kind, self.message)
483    }
484}
485
486impl std::error::Error for Error {}
487
488/// Represents an object.
489///
490/// This is a source file -> object file pair.
491#[derive(Clone, Debug)]
492struct Object {
493    src: PathBuf,
494    dst: PathBuf,
495}
496
497impl Object {
498    /// Create a new source file -> object file pair.
499    fn new(src: PathBuf, dst: PathBuf) -> Object {
500        Object { src, dst }
501    }
502}
503
504/// Configure the builder.
505impl Build {
506    /// Construct a new instance of a blank set of configuration.
507    ///
508    /// This builder is finished with the [`compile`] function.
509    ///
510    /// [`compile`]: struct.Build.html#method.compile
511    pub fn new() -> Build {
512        Build {
513            include_directories: Vec::new(),
514            definitions: Vec::new(),
515            objects: Vec::new(),
516            flags: Vec::new(),
517            flags_supported: Vec::new(),
518            ar_flags: Vec::new(),
519            asm_flags: Vec::new(),
520            no_default_flags: false,
521            files: Vec::new(),
522            shared_flag: None,
523            static_flag: None,
524            cpp: false,
525            cpp_link_stdlib: None,
526            cpp_link_stdlib_static: false,
527            cpp_set_stdlib: None,
528            cuda: false,
529            cudart: None,
530            ccbin: true,
531            std: None,
532            target: None,
533            host: None,
534            out_dir: None,
535            opt_level: None,
536            debug: None,
537            force_frame_pointer: None,
538            env: Vec::new(),
539            compiler: None,
540            archiver: None,
541            ranlib: None,
542            cargo_output: CargoOutput::new(),
543            link_lib_modifiers: Vec::new(),
544            pic: None,
545            use_plt: None,
546            static_crt: None,
547            warnings: None,
548            extra_warnings: None,
549            warnings_into_errors: false,
550            emit_rerun_if_env_changed: true,
551            shell_escaped_flags: None,
552            build_cache: Arc::default(),
553            inherit_rustflags: true,
554            prefer_clang_cl_over_msvc: false,
555        }
556    }
557
558    /// Add a directory to the `-I` or include path for headers
559    ///
560    /// # Example
561    ///
562    /// ```no_run
563    /// use std::path::Path;
564    ///
565    /// let library_path = Path::new("/path/to/library");
566    ///
567    /// cc::Build::new()
568    ///     .file("src/foo.c")
569    ///     .include(library_path)
570    ///     .include("src")
571    ///     .compile("foo");
572    /// ```
573    pub fn include<P: AsRef<Path>>(&mut self, dir: P) -> &mut Build {
574        self.include_directories.push(dir.as_ref().into());
575        self
576    }
577
578    /// Add multiple directories to the `-I` include path.
579    ///
580    /// # Example
581    ///
582    /// ```no_run
583    /// # use std::path::Path;
584    /// # let condition = true;
585    /// #
586    /// let mut extra_dir = None;
587    /// if condition {
588    ///     extra_dir = Some(Path::new("/path/to"));
589    /// }
590    ///
591    /// cc::Build::new()
592    ///     .file("src/foo.c")
593    ///     .includes(extra_dir)
594    ///     .compile("foo");
595    /// ```
596    pub fn includes<P>(&mut self, dirs: P) -> &mut Build
597    where
598        P: IntoIterator,
599        P::Item: AsRef<Path>,
600    {
601        for dir in dirs {
602            self.include(dir);
603        }
604        self
605    }
606
607    /// Specify a `-D` variable with an optional value.
608    ///
609    /// # Example
610    ///
611    /// ```no_run
612    /// cc::Build::new()
613    ///     .file("src/foo.c")
614    ///     .define("FOO", "BAR")
615    ///     .define("BAZ", None)
616    ///     .compile("foo");
617    /// ```
618    pub fn define<'a, V: Into<Option<&'a str>>>(&mut self, var: &str, val: V) -> &mut Build {
619        self.definitions
620            .push((var.into(), val.into().map(Into::into)));
621        self
622    }
623
624    /// Add an arbitrary object file to link in
625    pub fn object<P: AsRef<Path>>(&mut self, obj: P) -> &mut Build {
626        self.objects.push(obj.as_ref().into());
627        self
628    }
629
630    /// Add arbitrary object files to link in
631    pub fn objects<P>(&mut self, objs: P) -> &mut Build
632    where
633        P: IntoIterator,
634        P::Item: AsRef<Path>,
635    {
636        for obj in objs {
637            self.object(obj);
638        }
639        self
640    }
641
642    /// Add an arbitrary flag to the invocation of the compiler
643    ///
644    /// # Example
645    ///
646    /// ```no_run
647    /// cc::Build::new()
648    ///     .file("src/foo.c")
649    ///     .flag("-ffunction-sections")
650    ///     .compile("foo");
651    /// ```
652    pub fn flag(&mut self, flag: impl AsRef<OsStr>) -> &mut Build {
653        self.flags.push(flag.as_ref().into());
654        self
655    }
656
657    /// Add multiple flags to the invocation of the compiler.
658    /// This is equivalent to calling [`flag`](Self::flag) for each item in the iterator.
659    ///
660    /// # Example
661    /// ```no_run
662    /// cc::Build::new()
663    ///     .file("src/foo.c")
664    ///     .flags(["-Wall", "-Wextra"])
665    ///     .compile("foo");
666    /// ```
667    pub fn flags<Iter>(&mut self, flags: Iter) -> &mut Build
668    where
669        Iter: IntoIterator,
670        Iter::Item: AsRef<OsStr>,
671    {
672        for flag in flags {
673            self.flag(flag);
674        }
675        self
676    }
677
678    /// Removes a compiler flag that was added by [`Build::flag`].
679    ///
680    /// Will not remove flags added by other means (default flags,
681    /// flags from env, and so on).
682    ///
683    /// # Example
684    /// ```
685    /// cc::Build::new()
686    ///     .file("src/foo.c")
687    ///     .flag("unwanted_flag")
688    ///     .remove_flag("unwanted_flag");
689    /// ```
690    pub fn remove_flag(&mut self, flag: &str) -> &mut Build {
691        self.flags.retain(|other_flag| &**other_flag != flag);
692        self
693    }
694
695    /// Add a flag to the invocation of the ar
696    ///
697    /// # Example
698    ///
699    /// ```no_run
700    /// cc::Build::new()
701    ///     .file("src/foo.c")
702    ///     .file("src/bar.c")
703    ///     .ar_flag("/NODEFAULTLIB:libc.dll")
704    ///     .compile("foo");
705    /// ```
706    pub fn ar_flag(&mut self, flag: impl AsRef<OsStr>) -> &mut Build {
707        self.ar_flags.push(flag.as_ref().into());
708        self
709    }
710
711    /// Add a flag that will only be used with assembly files.
712    ///
713    /// The flag will be applied to input files with either a `.s` or
714    /// `.asm` extension (case insensitive).
715    ///
716    /// # Example
717    ///
718    /// ```no_run
719    /// cc::Build::new()
720    ///     .asm_flag("-Wa,-defsym,abc=1")
721    ///     .file("src/foo.S")  // The asm flag will be applied here
722    ///     .file("src/bar.c")  // The asm flag will not be applied here
723    ///     .compile("foo");
724    /// ```
725    pub fn asm_flag(&mut self, flag: impl AsRef<OsStr>) -> &mut Build {
726        self.asm_flags.push(flag.as_ref().into());
727        self
728    }
729
730    /// Add an arbitrary flag to the invocation of the compiler if it supports it
731    ///
732    /// # Example
733    ///
734    /// ```no_run
735    /// cc::Build::new()
736    ///     .file("src/foo.c")
737    ///     .flag_if_supported("-Wlogical-op") // only supported by GCC
738    ///     .flag_if_supported("-Wunreachable-code") // only supported by clang
739    ///     .compile("foo");
740    /// ```
741    pub fn flag_if_supported(&mut self, flag: impl AsRef<OsStr>) -> &mut Build {
742        self.flags_supported.push(flag.as_ref().into());
743        self
744    }
745
746    /// Add flags from the specified environment variable.
747    ///
748    /// Normally the `cc` crate will consult with the standard set of environment
749    /// variables (such as `CFLAGS` and `CXXFLAGS`) to construct the compiler invocation. Use of
750    /// this method provides additional levers for the end user to use when configuring the build
751    /// process.
752    ///
753    /// Just like the standard variables, this method will search for an environment variable with
754    /// appropriate target prefixes, when appropriate.
755    ///
756    /// # Examples
757    ///
758    /// This method is particularly beneficial in introducing the ability to specify crate-specific
759    /// flags.
760    ///
761    /// ```no_run
762    /// cc::Build::new()
763    ///     .file("src/foo.c")
764    ///     .try_flags_from_environment(concat!(env!("CARGO_PKG_NAME"), "_CFLAGS"))
765    ///     .expect("the environment variable must be specified and UTF-8")
766    ///     .compile("foo");
767    /// ```
768    ///
769    pub fn try_flags_from_environment(&mut self, environ_key: &str) -> Result<&mut Build, Error> {
770        let flags = self.envflags(environ_key)?.ok_or_else(|| {
771            Error::new(
772                ErrorKind::EnvVarNotFound,
773                format!("could not find environment variable {environ_key}"),
774            )
775        })?;
776        self.flags.extend(
777            flags
778                .into_iter()
779                .map(|flag| Arc::from(OsString::from(flag).as_os_str())),
780        );
781        Ok(self)
782    }
783
784    /// Set the `-shared` flag.
785    ///
786    /// When enabled, the compiler will produce a shared object which can
787    /// then be linked with other objects to form an executable.
788    ///
789    /// # Example
790    ///
791    /// ```no_run
792    /// cc::Build::new()
793    ///     .file("src/foo.c")
794    ///     .shared_flag(true)
795    ///     .compile("libfoo.so");
796    /// ```
797    pub fn shared_flag(&mut self, shared_flag: bool) -> &mut Build {
798        self.shared_flag = Some(shared_flag);
799        self
800    }
801
802    /// Set the `-static` flag.
803    ///
804    /// When enabled on systems that support dynamic linking, this prevents
805    /// linking with the shared libraries.
806    ///
807    /// # Example
808    ///
809    /// ```no_run
810    /// cc::Build::new()
811    ///     .file("src/foo.c")
812    ///     .shared_flag(true)
813    ///     .static_flag(true)
814    ///     .compile("foo");
815    /// ```
816    pub fn static_flag(&mut self, static_flag: bool) -> &mut Build {
817        self.static_flag = Some(static_flag);
818        self
819    }
820
821    /// Disables the generation of default compiler flags. The default compiler
822    /// flags may cause conflicts in some cross compiling scenarios.
823    ///
824    /// Setting the `CRATE_CC_NO_DEFAULTS` environment variable has the same
825    /// effect as setting this to `true`. The presence of the environment
826    /// variable and the value of `no_default_flags` will be OR'd together.
827    pub fn no_default_flags(&mut self, no_default_flags: bool) -> &mut Build {
828        self.no_default_flags = no_default_flags;
829        self
830    }
831
832    /// Add a file which will be compiled
833    pub fn file<P: AsRef<Path>>(&mut self, p: P) -> &mut Build {
834        self.files.push(p.as_ref().into());
835        self
836    }
837
838    /// Add files which will be compiled
839    pub fn files<P>(&mut self, p: P) -> &mut Build
840    where
841        P: IntoIterator,
842        P::Item: AsRef<Path>,
843    {
844        for file in p.into_iter() {
845            self.file(file);
846        }
847        self
848    }
849
850    /// Get the files which will be compiled
851    pub fn get_files(&self) -> impl Iterator<Item = &Path> {
852        self.files.iter().map(AsRef::as_ref)
853    }
854
855    /// Set C++ support.
856    ///
857    /// The other `cpp_*` options will only become active if this is set to
858    /// `true`.
859    ///
860    /// The name of the C++ standard library to link is decided by:
861    /// 1. If [`cpp_link_stdlib`](Build::cpp_link_stdlib) is set, use its value.
862    /// 2. Else if the `CXXSTDLIB` environment variable is set, use its value.
863    /// 3. Else the default is `c++` for OS X and BSDs, `c++_shared` for Android,
864    ///    `None` for MSVC and `stdc++` for anything else.
865    pub fn cpp(&mut self, cpp: bool) -> &mut Build {
866        self.cpp = cpp;
867        self
868    }
869
870    /// Set CUDA C++ support.
871    ///
872    /// Enabling CUDA will invoke the CUDA compiler, NVCC. While NVCC accepts
873    /// the most common compiler flags, e.g. `-std=c++17`, some project-specific
874    /// flags might have to be prefixed with "-Xcompiler" flag, for example as
875    /// `.flag("-Xcompiler").flag("-fpermissive")`. See the documentation for
876    /// `nvcc`, the CUDA compiler driver, at <https://docs.nvidia.com/cuda/cuda-compiler-driver-nvcc/>
877    /// for more information.
878    ///
879    /// If enabled, this also implicitly enables C++ support.
880    pub fn cuda(&mut self, cuda: bool) -> &mut Build {
881        self.cuda = cuda;
882        if cuda {
883            self.cpp = true;
884            self.cudart = Some("static".into());
885        }
886        self
887    }
888
889    /// Link CUDA run-time.
890    ///
891    /// This option mimics the `--cudart` NVCC command-line option. Just like
892    /// the original it accepts `{none|shared|static}`, with default being
893    /// `static`. The method has to be invoked after `.cuda(true)`, or not
894    /// at all, if the default is right for the project.
895    pub fn cudart(&mut self, cudart: &str) -> &mut Build {
896        if self.cuda {
897            self.cudart = Some(cudart.into());
898        }
899        self
900    }
901
902    /// Set CUDA host compiler.
903    ///
904    /// By default, a `-ccbin` flag will be passed to NVCC to specify the
905    /// underlying host compiler. The value of `-ccbin` is the same as the
906    /// chosen C++ compiler. This is not always desired, because NVCC might
907    /// not support that compiler. In this case, you can remove the `-ccbin`
908    /// flag so that NVCC will choose the host compiler by itself.
909    pub fn ccbin(&mut self, ccbin: bool) -> &mut Build {
910        self.ccbin = ccbin;
911        self
912    }
913
914    /// Specify the C or C++ language standard version.
915    ///
916    /// These values are common to modern versions of GCC, Clang and MSVC:
917    /// - `c11` for ISO/IEC 9899:2011
918    /// - `c17` for ISO/IEC 9899:2018
919    /// - `c++14` for ISO/IEC 14882:2014
920    /// - `c++17` for ISO/IEC 14882:2017
921    /// - `c++20` for ISO/IEC 14882:2020
922    ///
923    /// Other values have less broad support, e.g. MSVC does not support `c++11`
924    /// (`c++14` is the minimum), `c89` (omit the flag instead) or `c99`.
925    ///
926    /// For compiling C++ code, you should also set `.cpp(true)`.
927    ///
928    /// The default is that no standard flag is passed to the compiler, so the
929    /// language version will be the compiler's default.
930    ///
931    /// # Example
932    ///
933    /// ```no_run
934    /// cc::Build::new()
935    ///     .file("src/modern.cpp")
936    ///     .cpp(true)
937    ///     .std("c++17")
938    ///     .compile("modern");
939    /// ```
940    pub fn std(&mut self, std: &str) -> &mut Build {
941        self.std = Some(std.into());
942        self
943    }
944
945    /// Set warnings into errors flag.
946    ///
947    /// Disabled by default.
948    ///
949    /// Warning: turning warnings into errors only make sense
950    /// if you are a developer of the crate using cc-rs.
951    /// Some warnings only appear on some architecture or
952    /// specific version of the compiler. Any user of this crate,
953    /// or any other crate depending on it, could fail during
954    /// compile time.
955    ///
956    /// # Example
957    ///
958    /// ```no_run
959    /// cc::Build::new()
960    ///     .file("src/foo.c")
961    ///     .warnings_into_errors(true)
962    ///     .compile("libfoo.a");
963    /// ```
964    pub fn warnings_into_errors(&mut self, warnings_into_errors: bool) -> &mut Build {
965        self.warnings_into_errors = warnings_into_errors;
966        self
967    }
968
969    /// Set warnings flags.
970    ///
971    /// Adds some flags:
972    /// - "-Wall" for MSVC.
973    /// - "-Wall", "-Wextra" for GNU and Clang.
974    ///
975    /// Enabled by default.
976    ///
977    /// # Example
978    ///
979    /// ```no_run
980    /// cc::Build::new()
981    ///     .file("src/foo.c")
982    ///     .warnings(false)
983    ///     .compile("libfoo.a");
984    /// ```
985    pub fn warnings(&mut self, warnings: bool) -> &mut Build {
986        self.warnings = Some(warnings);
987        self.extra_warnings = Some(warnings);
988        self
989    }
990
991    /// Set extra warnings flags.
992    ///
993    /// Adds some flags:
994    /// - nothing for MSVC.
995    /// - "-Wextra" for GNU and Clang.
996    ///
997    /// Enabled by default.
998    ///
999    /// # Example
1000    ///
1001    /// ```no_run
1002    /// // Disables -Wextra, -Wall remains enabled:
1003    /// cc::Build::new()
1004    ///     .file("src/foo.c")
1005    ///     .extra_warnings(false)
1006    ///     .compile("libfoo.a");
1007    /// ```
1008    pub fn extra_warnings(&mut self, warnings: bool) -> &mut Build {
1009        self.extra_warnings = Some(warnings);
1010        self
1011    }
1012
1013    /// Set the standard library to link against when compiling with C++
1014    /// support.
1015    ///
1016    /// If the `CXXSTDLIB` environment variable is set, its value will
1017    /// override the default value, but not the value explicitly set by calling
1018    /// this function.
1019    ///
1020    /// A value of `None` indicates that no automatic linking should happen,
1021    /// otherwise cargo will link against the specified library.
1022    ///
1023    /// The given library name must not contain the `lib` prefix.
1024    ///
1025    /// Common values:
1026    /// - `stdc++` for GNU
1027    /// - `c++` for Clang
1028    /// - `c++_shared` or `c++_static` for Android
1029    ///
1030    /// # Example
1031    ///
1032    /// ```no_run
1033    /// cc::Build::new()
1034    ///     .file("src/foo.c")
1035    ///     .shared_flag(true)
1036    ///     .cpp_link_stdlib("stdc++")
1037    ///     .compile("libfoo.so");
1038    /// ```
1039    pub fn cpp_link_stdlib<'a, V: Into<Option<&'a str>>>(
1040        &mut self,
1041        cpp_link_stdlib: V,
1042    ) -> &mut Build {
1043        self.cpp_link_stdlib = Some(cpp_link_stdlib.into().map(Arc::from));
1044        self
1045    }
1046
1047    /// Force linker to statically link C++ stdlib. By default cc-rs will emit
1048    /// rustc-link flag to link against system C++ stdlib (e.g. libstdc++.so, libc++.so)
1049    /// Provide value of `true` if linking against system library is not desired
1050    ///
1051    /// Note that for `wasm32` target C++ stdlib will always be linked statically
1052    ///
1053    /// # Example
1054    ///
1055    /// ```no_run
1056    /// cc::Build::new()
1057    ///     .file("src/foo.cpp")
1058    ///     .cpp(true)
1059    ///     .cpp_link_stdlib("stdc++")
1060    ///     .cpp_link_stdlib_static(true)
1061    ///     .compile("foo");
1062    /// ```
1063    pub fn cpp_link_stdlib_static(&mut self, is_static: bool) -> &mut Build {
1064        self.cpp_link_stdlib_static = is_static;
1065        self
1066    }
1067
1068    /// Force the C++ compiler to use the specified standard library.
1069    ///
1070    /// Setting this option will automatically set `cpp_link_stdlib` to the same
1071    /// value.
1072    ///
1073    /// The default value of this option is always `None`.
1074    ///
1075    /// This option has no effect when compiling for a Visual Studio based
1076    /// target.
1077    ///
1078    /// This option sets the `-stdlib` flag, which is only supported by some
1079    /// compilers (clang, icc) but not by others (gcc). The library will not
1080    /// detect which compiler is used, as such it is the responsibility of the
1081    /// caller to ensure that this option is only used in conjunction with a
1082    /// compiler which supports the `-stdlib` flag.
1083    ///
1084    /// A value of `None` indicates that no specific C++ standard library should
1085    /// be used, otherwise `-stdlib` is added to the compile invocation.
1086    ///
1087    /// The given library name must not contain the `lib` prefix.
1088    ///
1089    /// Common values:
1090    /// - `stdc++` for GNU
1091    /// - `c++` for Clang
1092    ///
1093    /// # Example
1094    ///
1095    /// ```no_run
1096    /// cc::Build::new()
1097    ///     .file("src/foo.c")
1098    ///     .cpp_set_stdlib("c++")
1099    ///     .compile("libfoo.a");
1100    /// ```
1101    pub fn cpp_set_stdlib<'a, V: Into<Option<&'a str>>>(
1102        &mut self,
1103        cpp_set_stdlib: V,
1104    ) -> &mut Build {
1105        let cpp_set_stdlib = cpp_set_stdlib.into().map(Arc::from);
1106        self.cpp_set_stdlib.clone_from(&cpp_set_stdlib);
1107        self.cpp_link_stdlib = Some(cpp_set_stdlib);
1108        self
1109    }
1110
1111    /// Configures the `rustc` target this configuration will be compiling
1112    /// for.
1113    ///
1114    /// This will fail if using a target not in a pre-compiled list taken from
1115    /// `rustc +nightly --print target-list`. The list will be updated
1116    /// periodically.
1117    ///
1118    /// You should avoid setting this in build scripts, target information
1119    /// will instead be retrieved from the environment variables `TARGET` and
1120    /// `CARGO_CFG_TARGET_*` that Cargo sets.
1121    ///
1122    /// # Example
1123    ///
1124    /// ```no_run
1125    /// cc::Build::new()
1126    ///     .file("src/foo.c")
1127    ///     .target("aarch64-linux-android")
1128    ///     .compile("foo");
1129    /// ```
1130    pub fn target(&mut self, target: &str) -> &mut Build {
1131        self.target = Some(target.into());
1132        self
1133    }
1134
1135    /// Configures the host assumed by this configuration.
1136    ///
1137    /// This option is automatically scraped from the `HOST` environment
1138    /// variable by build scripts, so it's not required to call this function.
1139    ///
1140    /// # Example
1141    ///
1142    /// ```no_run
1143    /// cc::Build::new()
1144    ///     .file("src/foo.c")
1145    ///     .host("arm-linux-gnueabihf")
1146    ///     .compile("foo");
1147    /// ```
1148    pub fn host(&mut self, host: &str) -> &mut Build {
1149        self.host = Some(host.into());
1150        self
1151    }
1152
1153    /// Configures the optimization level of the generated object files.
1154    ///
1155    /// This option is automatically scraped from the `OPT_LEVEL` environment
1156    /// variable by build scripts, so it's not required to call this function.
1157    pub fn opt_level(&mut self, opt_level: u32) -> &mut Build {
1158        self.opt_level = Some(opt_level.to_string().into());
1159        self
1160    }
1161
1162    /// Configures the optimization level of the generated object files.
1163    ///
1164    /// This option is automatically scraped from the `OPT_LEVEL` environment
1165    /// variable by build scripts, so it's not required to call this function.
1166    pub fn opt_level_str(&mut self, opt_level: &str) -> &mut Build {
1167        self.opt_level = Some(opt_level.into());
1168        self
1169    }
1170
1171    /// Configures whether the compiler will emit debug information when
1172    /// generating object files.
1173    ///
1174    /// This option is automatically scraped from the `DEBUG` environment
1175    /// variable by build scripts, so it's not required to call this function.
1176    pub fn debug(&mut self, debug: bool) -> &mut Build {
1177        self.debug = Some(debug);
1178        self
1179    }
1180
1181    /// Configures whether the compiler will emit instructions to store
1182    /// frame pointers during codegen.
1183    ///
1184    /// This option is automatically enabled when debug information is emitted.
1185    /// Otherwise the target platform compiler's default will be used.
1186    /// You can use this option to force a specific setting.
1187    pub fn force_frame_pointer(&mut self, force: bool) -> &mut Build {
1188        self.force_frame_pointer = Some(force);
1189        self
1190    }
1191
1192    /// Configures the output directory where all object files and static
1193    /// libraries will be located.
1194    ///
1195    /// This option is automatically scraped from the `OUT_DIR` environment
1196    /// variable by build scripts, so it's not required to call this function.
1197    pub fn out_dir<P: AsRef<Path>>(&mut self, out_dir: P) -> &mut Build {
1198        self.out_dir = Some(out_dir.as_ref().into());
1199        self
1200    }
1201
1202    /// Configures the compiler to be used to produce output.
1203    ///
1204    /// This option is automatically determined from the target platform or a
1205    /// number of environment variables, so it's not required to call this
1206    /// function.
1207    pub fn compiler<P: AsRef<Path>>(&mut self, compiler: P) -> &mut Build {
1208        self.compiler = Some(compiler.as_ref().into());
1209        self
1210    }
1211
1212    /// Configures the tool used to assemble archives.
1213    ///
1214    /// This option is automatically determined from the target platform or a
1215    /// number of environment variables, so it's not required to call this
1216    /// function.
1217    pub fn archiver<P: AsRef<Path>>(&mut self, archiver: P) -> &mut Build {
1218        self.archiver = Some(archiver.as_ref().into());
1219        self
1220    }
1221
1222    /// Configures the tool used to index archives.
1223    ///
1224    /// This option is automatically determined from the target platform or a
1225    /// number of environment variables, so it's not required to call this
1226    /// function.
1227    pub fn ranlib<P: AsRef<Path>>(&mut self, ranlib: P) -> &mut Build {
1228        self.ranlib = Some(ranlib.as_ref().into());
1229        self
1230    }
1231
1232    /// Define whether metadata should be emitted for cargo allowing it to
1233    /// automatically link the binary. Defaults to `true`.
1234    ///
1235    /// The emitted metadata is:
1236    ///
1237    ///  - `rustc-link-lib=static=`*compiled lib*
1238    ///  - `rustc-link-search=native=`*target folder*
1239    ///  - When target is MSVC, the ATL-MFC libs are added via `rustc-link-search=native=`
1240    ///  - When C++ is enabled, the C++ stdlib is added via `rustc-link-lib`
1241    ///  - If `emit_rerun_if_env_changed` is not `false`, `rerun-if-env-changed=`*env*
1242    ///
1243    pub fn cargo_metadata(&mut self, cargo_metadata: bool) -> &mut Build {
1244        self.cargo_output.metadata = cargo_metadata;
1245        self
1246    }
1247
1248    /// Define whether compile warnings should be emitted for cargo. Defaults to
1249    /// `true`.
1250    ///
1251    /// If disabled, compiler messages will not be printed.
1252    /// Issues unrelated to the compilation will always produce cargo warnings regardless of this setting.
1253    pub fn cargo_warnings(&mut self, cargo_warnings: bool) -> &mut Build {
1254        self.cargo_output.warnings = cargo_warnings;
1255        self
1256    }
1257
1258    /// Define whether debug information should be emitted for cargo. Defaults to whether
1259    /// or not the environment variable `CC_ENABLE_DEBUG_OUTPUT` is set.
1260    ///
1261    /// If enabled, the compiler will emit debug information when generating object files,
1262    /// such as the command invoked and the exit status.
1263    pub fn cargo_debug(&mut self, cargo_debug: bool) -> &mut Build {
1264        self.cargo_output.debug = cargo_debug;
1265        self
1266    }
1267
1268    /// Define whether compiler output (to stdout) should be emitted. Defaults to `true`
1269    /// (forward compiler stdout to this process' stdout)
1270    ///
1271    /// Some compilers emit errors to stdout, so if you *really* need stdout to be clean
1272    /// you should also set this to `false`.
1273    pub fn cargo_output(&mut self, cargo_output: bool) -> &mut Build {
1274        self.cargo_output.output = if cargo_output {
1275            OutputKind::Forward
1276        } else {
1277            OutputKind::Discard
1278        };
1279        self
1280    }
1281
1282    /// Adds a native library modifier that will be added to the
1283    /// `rustc-link-lib=static:MODIFIERS=LIBRARY_NAME` metadata line
1284    /// emitted for cargo if `cargo_metadata` is enabled.
1285    /// See <https://doc.rust-lang.org/rustc/command-line-arguments.html#-l-link-the-generated-crate-to-a-native-library>
1286    /// for the list of modifiers accepted by rustc.
1287    pub fn link_lib_modifier(&mut self, link_lib_modifier: impl AsRef<OsStr>) -> &mut Build {
1288        self.link_lib_modifiers
1289            .push(link_lib_modifier.as_ref().into());
1290        self
1291    }
1292
1293    /// Configures whether the compiler will emit position independent code.
1294    ///
1295    /// This option defaults to `false` for `windows-gnu` and bare metal targets and
1296    /// to `true` for all other targets.
1297    pub fn pic(&mut self, pic: bool) -> &mut Build {
1298        self.pic = Some(pic);
1299        self
1300    }
1301
1302    /// Configures whether the Procedure Linkage Table is used for indirect
1303    /// calls into shared libraries.
1304    ///
1305    /// The PLT is used to provide features like lazy binding, but introduces
1306    /// a small performance loss due to extra pointer indirection. Setting
1307    /// `use_plt` to `false` can provide a small performance increase.
1308    ///
1309    /// Note that skipping the PLT requires a recent version of GCC/Clang.
1310    ///
1311    /// This only applies to ELF targets. It has no effect on other platforms.
1312    pub fn use_plt(&mut self, use_plt: bool) -> &mut Build {
1313        self.use_plt = Some(use_plt);
1314        self
1315    }
1316
1317    /// Define whether metadata should be emitted for cargo to only trigger
1318    /// rebuild when detected environment changes, by default build script is
1319    /// always run on every compilation if no rerun cargo metadata is emitted.
1320    ///
1321    /// NOTE that cc does not emit metadata to detect changes for `PATH`, since it could
1322    /// be changed every comilation yet does not affect the result of compilation
1323    /// (i.e. rust-analyzer adds temporary directory to `PATH`).
1324    ///
1325    /// cc in general, has no way detecting changes to compiler, as there are so many ways to
1326    /// change it and sidestep the detection, for example the compiler might be wrapped in a script
1327    /// so detecting change of the file, or using checksum won't work.
1328    ///
1329    /// We recommend users to decide for themselves, if they want rebuild if the compiler has been upgraded
1330    /// or changed, and how to detect that.
1331    ///
1332    /// This has no effect if the `cargo_metadata` option is `false`.
1333    ///
1334    /// This option defaults to `true`.
1335    pub fn emit_rerun_if_env_changed(&mut self, emit_rerun_if_env_changed: bool) -> &mut Build {
1336        self.emit_rerun_if_env_changed = emit_rerun_if_env_changed;
1337        self
1338    }
1339
1340    /// Configures whether the /MT flag or the /MD flag will be passed to msvc build tools.
1341    ///
1342    /// This option defaults to `false`, and affect only msvc targets.
1343    pub fn static_crt(&mut self, static_crt: bool) -> &mut Build {
1344        self.static_crt = Some(static_crt);
1345        self
1346    }
1347
1348    /// Configure whether *FLAGS variables are parsed using `shlex`, similarly to `make` and
1349    /// `cmake`.
1350    ///
1351    /// This option defaults to `false`.
1352    pub fn shell_escaped_flags(&mut self, shell_escaped_flags: bool) -> &mut Build {
1353        self.shell_escaped_flags = Some(shell_escaped_flags);
1354        self
1355    }
1356
1357    /// Configure whether cc should automatically inherit compatible flags passed to rustc
1358    /// from `CARGO_ENCODED_RUSTFLAGS`.
1359    ///
1360    /// This option defaults to `true`.
1361    pub fn inherit_rustflags(&mut self, inherit_rustflags: bool) -> &mut Build {
1362        self.inherit_rustflags = inherit_rustflags;
1363        self
1364    }
1365
1366    /// Prefer to use clang-cl over msvc.
1367    ///
1368    /// This option defaults to `false`.
1369    pub fn prefer_clang_cl_over_msvc(&mut self, prefer_clang_cl_over_msvc: bool) -> &mut Build {
1370        self.prefer_clang_cl_over_msvc = prefer_clang_cl_over_msvc;
1371        self
1372    }
1373
1374    #[doc(hidden)]
1375    pub fn __set_env<A, B>(&mut self, a: A, b: B) -> &mut Build
1376    where
1377        A: AsRef<OsStr>,
1378        B: AsRef<OsStr>,
1379    {
1380        self.env.push((a.as_ref().into(), b.as_ref().into()));
1381        self
1382    }
1383}
1384
1385/// Invoke or fetch the compiler or archiver.
1386impl Build {
1387    /// Run the compiler to test if it accepts the given flag.
1388    ///
1389    /// For a convenience method for setting flags conditionally,
1390    /// see `flag_if_supported()`.
1391    ///
1392    /// It may return error if it's unable to run the compiler with a test file
1393    /// (e.g. the compiler is missing or a write to the `out_dir` failed).
1394    ///
1395    /// Note: Once computed, the result of this call is stored in the
1396    /// `known_flag_support` field. If `is_flag_supported(flag)`
1397    /// is called again, the result will be read from the hash table.
1398    pub fn is_flag_supported(&self, flag: impl AsRef<OsStr>) -> Result<bool, Error> {
1399        self.is_flag_supported_inner(
1400            flag.as_ref(),
1401            &self.get_base_compiler()?,
1402            &self.get_target()?,
1403        )
1404    }
1405
1406    fn ensure_check_file(&self) -> Result<PathBuf, Error> {
1407        let out_dir = self.get_out_dir()?;
1408        let src = if self.cuda {
1409            assert!(self.cpp);
1410            out_dir.join("flag_check.cu")
1411        } else if self.cpp {
1412            out_dir.join("flag_check.cpp")
1413        } else {
1414            out_dir.join("flag_check.c")
1415        };
1416
1417        if !src.exists() {
1418            let mut f = fs::File::create(&src)?;
1419            write!(f, "int main(void) {{ return 0; }}")?;
1420        }
1421
1422        Ok(src)
1423    }
1424
1425    fn is_flag_supported_inner(
1426        &self,
1427        flag: &OsStr,
1428        tool: &Tool,
1429        target: &TargetInfo<'_>,
1430    ) -> Result<bool, Error> {
1431        let compiler_flag = CompilerFlag {
1432            compiler: tool.path().into(),
1433            flag: flag.into(),
1434        };
1435
1436        if let Some(is_supported) = self
1437            .build_cache
1438            .known_flag_support_status_cache
1439            .read()
1440            .unwrap()
1441            .get(&compiler_flag)
1442            .cloned()
1443        {
1444            return Ok(is_supported);
1445        }
1446
1447        let out_dir = self.get_out_dir()?;
1448        let src = self.ensure_check_file()?;
1449        let obj = out_dir.join("flag_check");
1450
1451        let mut compiler = {
1452            let mut cfg = Build::new();
1453            cfg.flag(flag)
1454                .compiler(tool.path())
1455                .cargo_metadata(self.cargo_output.metadata)
1456                .opt_level(0)
1457                .debug(false)
1458                .cpp(self.cpp)
1459                .cuda(self.cuda)
1460                .inherit_rustflags(false)
1461                .emit_rerun_if_env_changed(self.emit_rerun_if_env_changed);
1462            if let Some(target) = &self.target {
1463                cfg.target(target);
1464            }
1465            if let Some(host) = &self.host {
1466                cfg.host(host);
1467            }
1468            cfg.try_get_compiler()?
1469        };
1470
1471        // Clang uses stderr for verbose output, which yields a false positive
1472        // result if the CFLAGS/CXXFLAGS include -v to aid in debugging.
1473        if compiler.family.verbose_stderr() {
1474            compiler.remove_arg("-v".into());
1475        }
1476        if compiler.is_like_clang() {
1477            // Avoid reporting that the arg is unsupported just because the
1478            // compiler complains that it wasn't used.
1479            compiler.push_cc_arg("-Wno-unused-command-line-argument".into());
1480        }
1481
1482        let mut cmd = compiler.to_command();
1483        command_add_output_file(
1484            &mut cmd,
1485            &obj,
1486            CmdAddOutputFileArgs {
1487                cuda: self.cuda,
1488                is_assembler_msvc: false,
1489                msvc: compiler.is_like_msvc(),
1490                clang: compiler.is_like_clang(),
1491                gnu: compiler.is_like_gnu(),
1492                is_asm: false,
1493                is_arm: is_arm(target),
1494            },
1495        );
1496
1497        // Checking for compiler flags does not require linking (and we _must_
1498        // avoid making it do so, since it breaks cross-compilation when the C
1499        // compiler isn't configured to be able to link).
1500        // https://github.com/rust-lang/cc-rs/issues/1423
1501        cmd.arg("-c");
1502
1503        if compiler.supports_path_delimiter() {
1504            cmd.arg("--");
1505        }
1506
1507        cmd.arg(&src);
1508
1509        if compiler.is_like_msvc() {
1510            // On MSVC we need to make sure the LIB directory is included
1511            // so the CRT can be found.
1512            for (key, value) in &tool.env {
1513                if key == "LIB" {
1514                    cmd.env("LIB", value);
1515                    break;
1516                }
1517            }
1518        }
1519
1520        let output = cmd.current_dir(out_dir).output()?;
1521        let is_supported = output.status.success() && output.stderr.is_empty();
1522
1523        self.build_cache
1524            .known_flag_support_status_cache
1525            .write()
1526            .unwrap()
1527            .insert(compiler_flag, is_supported);
1528
1529        Ok(is_supported)
1530    }
1531
1532    /// Run the compiler, generating the file `output`
1533    ///
1534    /// This will return a result instead of panicking; see [`Self::compile()`] for
1535    /// the complete description.
1536    pub fn try_compile(&self, output: &str) -> Result<(), Error> {
1537        let mut output_components = Path::new(output).components();
1538        match (output_components.next(), output_components.next()) {
1539            (Some(Component::Normal(_)), None) => {}
1540            _ => {
1541                return Err(Error::new(
1542                    ErrorKind::InvalidArgument,
1543                    "argument of `compile` must be a single normal path component",
1544                ));
1545            }
1546        }
1547
1548        let (lib_name, gnu_lib_name) = if output.starts_with("lib") && output.ends_with(".a") {
1549            (&output[3..output.len() - 2], output.to_owned())
1550        } else {
1551            let mut gnu = String::with_capacity(5 + output.len());
1552            gnu.push_str("lib");
1553            gnu.push_str(output);
1554            gnu.push_str(".a");
1555            (output, gnu)
1556        };
1557        let dst = self.get_out_dir()?;
1558
1559        let objects = objects_from_files(&self.files, &dst)?;
1560
1561        self.compile_objects(&objects)?;
1562        self.assemble(lib_name, &dst.join(gnu_lib_name), &objects)?;
1563
1564        let target = self.get_target()?;
1565        if target.env == "msvc" {
1566            let compiler = self.get_base_compiler()?;
1567            let atlmfc_lib = compiler
1568                .env()
1569                .iter()
1570                .find(|&(var, _)| var.as_os_str() == OsStr::new("LIB"))
1571                .and_then(|(_, lib_paths)| {
1572                    env::split_paths(lib_paths).find(|path| {
1573                        let sub = Path::new("atlmfc/lib");
1574                        path.ends_with(sub) || path.parent().map_or(false, |p| p.ends_with(sub))
1575                    })
1576                });
1577
1578            if let Some(atlmfc_lib) = atlmfc_lib {
1579                self.cargo_output.print_metadata(&format_args!(
1580                    "cargo:rustc-link-search=native={}",
1581                    atlmfc_lib.display()
1582                ));
1583            }
1584        }
1585
1586        if self.link_lib_modifiers.is_empty() {
1587            self.cargo_output
1588                .print_metadata(&format_args!("cargo:rustc-link-lib=static={lib_name}"));
1589        } else {
1590            self.cargo_output.print_metadata(&format_args!(
1591                "cargo:rustc-link-lib=static:{}={}",
1592                JoinOsStrs {
1593                    slice: &self.link_lib_modifiers,
1594                    delimiter: ','
1595                },
1596                lib_name
1597            ));
1598        }
1599        self.cargo_output.print_metadata(&format_args!(
1600            "cargo:rustc-link-search=native={}",
1601            dst.display()
1602        ));
1603
1604        // Add specific C++ libraries, if enabled.
1605        if self.cpp {
1606            if let Some(stdlib) = self.get_cpp_link_stdlib()? {
1607                if self.cpp_link_stdlib_static {
1608                    self.cargo_output.print_metadata(&format_args!(
1609                        "cargo:rustc-link-lib=static={}",
1610                        stdlib.display()
1611                    ));
1612                } else {
1613                    self.cargo_output
1614                        .print_metadata(&format_args!("cargo:rustc-link-lib={}", stdlib.display()));
1615                }
1616            }
1617            // Link c++ lib from WASI sysroot
1618            if target.arch == "wasm32" {
1619                if target.os == "wasi" {
1620                    if let Ok(wasi_sysroot) = self.wasi_sysroot() {
1621                        self.cargo_output.print_metadata(&format_args!(
1622                            "cargo:rustc-flags=-L {}/lib/{} -lstatic=c++ -lstatic=c++abi",
1623                            Path::new(&wasi_sysroot).display(),
1624                            self.get_raw_target()?
1625                        ));
1626                    }
1627                } else if target.os == "linux" {
1628                    let musl_sysroot = self.wasm_musl_sysroot().unwrap();
1629                    self.cargo_output.print_metadata(&format_args!(
1630                        "cargo:rustc-flags=-L {}/lib -lstatic=c++ -lstatic=c++abi",
1631                        Path::new(&musl_sysroot).display(),
1632                    ));
1633                }
1634            }
1635        }
1636
1637        let cudart = match &self.cudart {
1638            Some(opt) => opt, // {none|shared|static}
1639            None => "none",
1640        };
1641        if cudart != "none" {
1642            if let Some(nvcc) = self.which(&self.get_compiler().path, None) {
1643                // Try to figure out the -L search path. If it fails,
1644                // it's on user to specify one by passing it through
1645                // RUSTFLAGS environment variable.
1646                let mut libtst = false;
1647                let mut libdir = nvcc;
1648                libdir.pop(); // remove 'nvcc'
1649                libdir.push("..");
1650                if cfg!(target_os = "linux") {
1651                    libdir.push("targets");
1652                    libdir.push(format!("{}-linux", target.arch));
1653                    libdir.push("lib");
1654                    libtst = true;
1655                } else if cfg!(target_env = "msvc") {
1656                    libdir.push("lib");
1657                    match target.arch {
1658                        "x86_64" => {
1659                            libdir.push("x64");
1660                            libtst = true;
1661                        }
1662                        "x86" => {
1663                            libdir.push("Win32");
1664                            libtst = true;
1665                        }
1666                        _ => libtst = false,
1667                    }
1668                }
1669                if libtst && libdir.is_dir() {
1670                    self.cargo_output.print_metadata(&format_args!(
1671                        "cargo:rustc-link-search=native={}",
1672                        libdir.to_str().unwrap()
1673                    ));
1674                }
1675
1676                // And now the -l flag.
1677                let lib = match cudart {
1678                    "shared" => "cudart",
1679                    "static" => "cudart_static",
1680                    bad => panic!("unsupported cudart option: {}", bad),
1681                };
1682                self.cargo_output
1683                    .print_metadata(&format_args!("cargo:rustc-link-lib={lib}"));
1684            }
1685        }
1686
1687        Ok(())
1688    }
1689
1690    /// Run the compiler, generating the file `output`
1691    ///
1692    /// # Library name
1693    ///
1694    /// The `output` string argument determines the file name for the compiled
1695    /// library. The Rust compiler will create an assembly named "lib"+output+".a".
1696    /// MSVC will create a file named output+".lib".
1697    ///
1698    /// The choice of `output` is close to arbitrary, but:
1699    ///
1700    /// - must be nonempty,
1701    /// - must not contain a path separator (`/`),
1702    /// - must be unique across all `compile` invocations made by the same build
1703    ///   script.
1704    ///
1705    /// If your build script compiles a single source file, the base name of
1706    /// that source file would usually be reasonable:
1707    ///
1708    /// ```no_run
1709    /// cc::Build::new().file("blobstore.c").compile("blobstore");
1710    /// ```
1711    ///
1712    /// Compiling multiple source files, some people use their crate's name, or
1713    /// their crate's name + "-cc".
1714    ///
1715    /// Otherwise, please use your imagination.
1716    ///
1717    /// For backwards compatibility, if `output` starts with "lib" *and* ends
1718    /// with ".a", a second "lib" prefix and ".a" suffix do not get added on,
1719    /// but this usage is deprecated; please omit `lib` and `.a` in the argument
1720    /// that you pass.
1721    ///
1722    /// # Panics
1723    ///
1724    /// Panics if `output` is not formatted correctly or if one of the underlying
1725    /// compiler commands fails. It can also panic if it fails reading file names
1726    /// or creating directories.
1727    pub fn compile(&self, output: &str) {
1728        if let Err(e) = self.try_compile(output) {
1729            fail(&e.message);
1730        }
1731    }
1732
1733    /// Run the compiler, generating intermediate files, but without linking
1734    /// them into an archive file.
1735    ///
1736    /// This will return a list of compiled object files, in the same order
1737    /// as they were passed in as `file`/`files` methods.
1738    pub fn compile_intermediates(&self) -> Vec<PathBuf> {
1739        match self.try_compile_intermediates() {
1740            Ok(v) => v,
1741            Err(e) => fail(&e.message),
1742        }
1743    }
1744
1745    /// Run the compiler, generating intermediate files, but without linking
1746    /// them into an archive file.
1747    ///
1748    /// This will return a result instead of panicking; see `compile_intermediates()` for the complete description.
1749    pub fn try_compile_intermediates(&self) -> Result<Vec<PathBuf>, Error> {
1750        let dst = self.get_out_dir()?;
1751        let objects = objects_from_files(&self.files, &dst)?;
1752
1753        self.compile_objects(&objects)?;
1754
1755        Ok(objects.into_iter().map(|v| v.dst).collect())
1756    }
1757
1758    fn compile_objects(&self, objs: &[Object]) -> Result<(), Error> {
1759        check_disabled()?;
1760
1761        #[cfg(feature = "parallel")]
1762        if objs.len() > 1 {
1763            return parallel::run_commands_in_parallel(
1764                &self.cargo_output,
1765                &mut objs.iter().map(|obj| self.create_compile_object_cmd(obj)),
1766            );
1767        }
1768
1769        for obj in objs {
1770            let mut cmd = self.create_compile_object_cmd(obj)?;
1771            run(&mut cmd, &self.cargo_output)?;
1772        }
1773
1774        Ok(())
1775    }
1776
1777    fn create_compile_object_cmd(&self, obj: &Object) -> Result<Command, Error> {
1778        let asm_ext = AsmFileExt::from_path(&obj.src);
1779        let is_asm = asm_ext.is_some();
1780        let target = self.get_target()?;
1781        let msvc = target.env == "msvc";
1782        let compiler = self.try_get_compiler()?;
1783
1784        let is_assembler_msvc = msvc && asm_ext == Some(AsmFileExt::DotAsm);
1785        let mut cmd = if is_assembler_msvc {
1786            self.msvc_macro_assembler()?
1787        } else {
1788            let mut cmd = compiler.to_command();
1789            for (a, b) in self.env.iter() {
1790                cmd.env(a, b);
1791            }
1792            cmd
1793        };
1794        let is_arm = is_arm(&target);
1795        command_add_output_file(
1796            &mut cmd,
1797            &obj.dst,
1798            CmdAddOutputFileArgs {
1799                cuda: self.cuda,
1800                is_assembler_msvc,
1801                msvc: compiler.is_like_msvc(),
1802                clang: compiler.is_like_clang(),
1803                gnu: compiler.is_like_gnu(),
1804                is_asm,
1805                is_arm,
1806            },
1807        );
1808        // armasm and armasm64 don't requrie -c option
1809        if !is_assembler_msvc || !is_arm {
1810            cmd.arg("-c");
1811        }
1812        if self.cuda && self.cuda_file_count() > 1 {
1813            cmd.arg("--device-c");
1814        }
1815        if is_asm {
1816            cmd.args(self.asm_flags.iter().map(std::ops::Deref::deref));
1817        }
1818
1819        if compiler.supports_path_delimiter() && !is_assembler_msvc {
1820            // #513: For `clang-cl`, separate flags/options from the input file.
1821            // When cross-compiling macOS -> Windows, this avoids interpreting
1822            // common `/Users/...` paths as the `/U` flag and triggering
1823            // `-Wslash-u-filename` warning.
1824            cmd.arg("--");
1825        }
1826        cmd.arg(&obj.src);
1827
1828        if cfg!(target_os = "macos") {
1829            self.fix_env_for_apple_os(&mut cmd)?;
1830        }
1831
1832        Ok(cmd)
1833    }
1834
1835    /// This will return a result instead of panicking; see [`Self::expand()`] for
1836    /// the complete description.
1837    pub fn try_expand(&self) -> Result<Vec<u8>, Error> {
1838        let compiler = self.try_get_compiler()?;
1839        let mut cmd = compiler.to_command();
1840        for (a, b) in self.env.iter() {
1841            cmd.env(a, b);
1842        }
1843        cmd.arg("-E");
1844
1845        assert!(
1846            self.files.len() <= 1,
1847            "Expand may only be called for a single file"
1848        );
1849
1850        let is_asm = self
1851            .files
1852            .iter()
1853            .map(std::ops::Deref::deref)
1854            .find_map(AsmFileExt::from_path)
1855            .is_some();
1856
1857        if compiler.family == (ToolFamily::Msvc { clang_cl: true }) && !is_asm {
1858            // #513: For `clang-cl`, separate flags/options from the input file.
1859            // When cross-compiling macOS -> Windows, this avoids interpreting
1860            // common `/Users/...` paths as the `/U` flag and triggering
1861            // `-Wslash-u-filename` warning.
1862            cmd.arg("--");
1863        }
1864
1865        cmd.args(self.files.iter().map(std::ops::Deref::deref));
1866
1867        run_output(&mut cmd, &self.cargo_output)
1868    }
1869
1870    /// Run the compiler, returning the macro-expanded version of the input files.
1871    ///
1872    /// This is only relevant for C and C++ files.
1873    ///
1874    /// # Panics
1875    /// Panics if more than one file is present in the config, or if compiler
1876    /// path has an invalid file name.
1877    ///
1878    /// # Example
1879    /// ```no_run
1880    /// let out = cc::Build::new().file("src/foo.c").expand();
1881    /// ```
1882    pub fn expand(&self) -> Vec<u8> {
1883        match self.try_expand() {
1884            Err(e) => fail(&e.message),
1885            Ok(v) => v,
1886        }
1887    }
1888
1889    /// Get the compiler that's in use for this configuration.
1890    ///
1891    /// This function will return a `Tool` which represents the culmination
1892    /// of this configuration at a snapshot in time. The returned compiler can
1893    /// be inspected (e.g. the path, arguments, environment) to forward along to
1894    /// other tools, or the `to_command` method can be used to invoke the
1895    /// compiler itself.
1896    ///
1897    /// This method will take into account all configuration such as debug
1898    /// information, optimization level, include directories, defines, etc.
1899    /// Additionally, the compiler binary in use follows the standard
1900    /// conventions for this path, e.g. looking at the explicitly set compiler,
1901    /// environment variables (a number of which are inspected here), and then
1902    /// falling back to the default configuration.
1903    ///
1904    /// # Panics
1905    ///
1906    /// Panics if an error occurred while determining the architecture.
1907    pub fn get_compiler(&self) -> Tool {
1908        match self.try_get_compiler() {
1909            Ok(tool) => tool,
1910            Err(e) => fail(&e.message),
1911        }
1912    }
1913
1914    /// Get the compiler that's in use for this configuration.
1915    ///
1916    /// This will return a result instead of panicking; see
1917    /// [`get_compiler()`](Self::get_compiler) for the complete description.
1918    pub fn try_get_compiler(&self) -> Result<Tool, Error> {
1919        let opt_level = self.get_opt_level()?;
1920        let target = self.get_target()?;
1921
1922        let mut cmd = self.get_base_compiler()?;
1923
1924        // The flags below are added in roughly the following order:
1925        // 1. Default flags
1926        //   - Controlled by `cc-rs`.
1927        // 2. `rustc`-inherited flags
1928        //   - Controlled by `rustc`.
1929        // 3. Builder flags
1930        //   - Controlled by the developer using `cc-rs` in e.g. their `build.rs`.
1931        // 4. Environment flags
1932        //   - Controlled by the end user.
1933        //
1934        // This is important to allow later flags to override previous ones.
1935
1936        // Copied from <https://github.com/rust-lang/rust/blob/5db81020006d2920fc9c62ffc0f4322f90bffa04/compiler/rustc_codegen_ssa/src/back/linker.rs#L27-L38>
1937        //
1938        // Disables non-English messages from localized linkers.
1939        // Such messages may cause issues with text encoding on Windows
1940        // and prevent inspection of msvc output in case of errors, which we occasionally do.
1941        // This should be acceptable because other messages from rustc are in English anyway,
1942        // and may also be desirable to improve searchability of the compiler diagnostics.
1943        if matches!(cmd.family, ToolFamily::Msvc { clang_cl: false }) {
1944            cmd.env.push(("VSLANG".into(), "1033".into()));
1945        } else {
1946            cmd.env.push(("LC_ALL".into(), "C".into()));
1947        }
1948
1949        // Disable default flag generation via `no_default_flags` or environment variable
1950        let no_defaults = self.no_default_flags || self.getenv_boolean("CRATE_CC_NO_DEFAULTS");
1951        if !no_defaults {
1952            self.add_default_flags(&mut cmd, &target, &opt_level)?;
1953        }
1954
1955        // Specify various flags that are not considered part of the default flags above.
1956        // FIXME(madsmtm): Should these be considered part of the defaults? If no, why not?
1957        if let Some(ref std) = self.std {
1958            let separator = match cmd.family {
1959                ToolFamily::Msvc { .. } => ':',
1960                ToolFamily::Gnu | ToolFamily::Clang { .. } => '=',
1961            };
1962            cmd.push_cc_arg(format!("-std{separator}{std}").into());
1963        }
1964        for directory in self.include_directories.iter() {
1965            cmd.args.push("-I".into());
1966            cmd.args.push(directory.as_os_str().into());
1967        }
1968        if self.warnings_into_errors {
1969            let warnings_to_errors_flag = cmd.family.warnings_to_errors_flag().into();
1970            cmd.push_cc_arg(warnings_to_errors_flag);
1971        }
1972
1973        // If warnings and/or extra_warnings haven't been explicitly set,
1974        // then we set them only if the environment doesn't already have
1975        // CFLAGS/CXXFLAGS, since those variables presumably already contain
1976        // the desired set of warnings flags.
1977        let envflags = self.envflags(if self.cpp { "CXXFLAGS" } else { "CFLAGS" })?;
1978        if self.warnings.unwrap_or(envflags.is_none()) {
1979            let wflags = cmd.family.warnings_flags().into();
1980            cmd.push_cc_arg(wflags);
1981        }
1982        if self.extra_warnings.unwrap_or(envflags.is_none()) {
1983            if let Some(wflags) = cmd.family.extra_warnings_flags() {
1984                cmd.push_cc_arg(wflags.into());
1985            }
1986        }
1987
1988        // Add cc flags inherited from matching rustc flags.
1989        if self.inherit_rustflags {
1990            self.add_inherited_rustflags(&mut cmd, &target)?;
1991        }
1992
1993        // Set flags configured in the builder (do this second-to-last, to allow these to override
1994        // everything above).
1995        for flag in self.flags.iter() {
1996            cmd.args.push((**flag).into());
1997        }
1998        for flag in self.flags_supported.iter() {
1999            if self
2000                .is_flag_supported_inner(flag, &cmd, &target)
2001                .unwrap_or(false)
2002            {
2003                cmd.push_cc_arg((**flag).into());
2004            }
2005        }
2006        for (key, value) in self.definitions.iter() {
2007            if let Some(ref value) = *value {
2008                cmd.args.push(format!("-D{key}={value}").into());
2009            } else {
2010                cmd.args.push(format!("-D{key}").into());
2011            }
2012        }
2013
2014        // Set flags from the environment (do this last, to allow these to override everything else).
2015        if let Some(flags) = &envflags {
2016            for arg in flags {
2017                cmd.push_cc_arg(arg.into());
2018            }
2019        }
2020
2021        Ok(cmd)
2022    }
2023
2024    fn add_default_flags(
2025        &self,
2026        cmd: &mut Tool,
2027        target: &TargetInfo<'_>,
2028        opt_level: &str,
2029    ) -> Result<(), Error> {
2030        let raw_target = self.get_raw_target()?;
2031        // Non-target flags
2032        // If the flag is not conditioned on target variable, it belongs here :)
2033        match cmd.family {
2034            ToolFamily::Msvc { .. } => {
2035                cmd.push_cc_arg("-nologo".into());
2036
2037                let crt_flag = match self.static_crt {
2038                    Some(true) => "-MT",
2039                    Some(false) => "-MD",
2040                    None => {
2041                        let features = self.getenv("CARGO_CFG_TARGET_FEATURE");
2042                        let features = features.as_deref().unwrap_or_default();
2043                        if features.to_string_lossy().contains("crt-static") {
2044                            "-MT"
2045                        } else {
2046                            "-MD"
2047                        }
2048                    }
2049                };
2050                cmd.push_cc_arg(crt_flag.into());
2051
2052                match opt_level {
2053                    // Msvc uses /O1 to enable all optimizations that minimize code size.
2054                    "z" | "s" | "1" => cmd.push_opt_unless_duplicate("-O1".into()),
2055                    // -O3 is a valid value for gcc and clang compilers, but not msvc. Cap to /O2.
2056                    "2" | "3" => cmd.push_opt_unless_duplicate("-O2".into()),
2057                    _ => {}
2058                }
2059            }
2060            ToolFamily::Gnu | ToolFamily::Clang { .. } => {
2061                // arm-linux-androideabi-gcc 4.8 shipped with Android NDK does
2062                // not support '-Oz'
2063                if opt_level == "z" && !cmd.is_like_clang() {
2064                    cmd.push_opt_unless_duplicate("-Os".into());
2065                } else {
2066                    cmd.push_opt_unless_duplicate(format!("-O{opt_level}").into());
2067                }
2068
2069                if cmd.is_like_clang() && target.os == "android" {
2070                    // For compatibility with code that doesn't use pre-defined `__ANDROID__` macro.
2071                    // If compiler used via ndk-build or cmake (officially supported build methods)
2072                    // this macros is defined.
2073                    // See https://android.googlesource.com/platform/ndk/+/refs/heads/ndk-release-r21/build/cmake/android.toolchain.cmake#456
2074                    // https://android.googlesource.com/platform/ndk/+/refs/heads/ndk-release-r21/build/core/build-binary.mk#141
2075                    cmd.push_opt_unless_duplicate("-DANDROID".into());
2076                }
2077
2078                if target.os != "ios"
2079                    && target.os != "watchos"
2080                    && target.os != "tvos"
2081                    && target.os != "visionos"
2082                {
2083                    cmd.push_cc_arg("-ffunction-sections".into());
2084                    cmd.push_cc_arg("-fdata-sections".into());
2085                }
2086                // Disable generation of PIC on bare-metal for now: rust-lld doesn't support this yet
2087                //
2088                // `rustc` also defaults to disable PIC on WASM:
2089                // <https://github.com/rust-lang/rust/blob/1.82.0/compiler/rustc_target/src/spec/base/wasm.rs#L101-L108>
2090                if self.pic.unwrap_or(
2091                    target.os != "windows"
2092                        && target.os != "none"
2093                        && target.os != "uefi"
2094                        && target.arch != "wasm32"
2095                        && target.arch != "wasm64",
2096                ) {
2097                    cmd.push_cc_arg("-fPIC".into());
2098                    // PLT only applies if code is compiled with PIC support,
2099                    // and only for ELF targets.
2100                    if (target.os == "linux" || target.os == "android")
2101                        && !self.use_plt.unwrap_or(true)
2102                    {
2103                        cmd.push_cc_arg("-fno-plt".into());
2104                    }
2105                }
2106                if target.arch == "wasm32" || target.arch == "wasm64" {
2107                    // WASI does not support exceptions yet.
2108                    // https://github.com/WebAssembly/exception-handling
2109                    //
2110                    // `rustc` also defaults to (currently) disable exceptions
2111                    // on all WASM targets:
2112                    // <https://github.com/rust-lang/rust/blob/1.82.0/compiler/rustc_target/src/spec/base/wasm.rs#L72-L77>
2113                    cmd.push_cc_arg("-fno-exceptions".into());
2114                }
2115
2116                if target.os == "wasi" {
2117                    // Link clang sysroot
2118                    if let Ok(wasi_sysroot) = self.wasi_sysroot() {
2119                        cmd.push_cc_arg(
2120                            format!("--sysroot={}", Path::new(&wasi_sysroot).display()).into(),
2121                        );
2122                    }
2123
2124                    // FIXME(madsmtm): Read from `target_features` instead?
2125                    if raw_target.contains("threads") {
2126                        cmd.push_cc_arg("-pthread".into());
2127                    }
2128                }
2129
2130                if target.os == "nto" {
2131                    // Select the target with `-V`, see qcc documentation:
2132                    // QNX 7.1: https://www.qnx.com/developers/docs/7.1/index.html#com.qnx.doc.neutrino.utilities/topic/q/qcc.html
2133                    // QNX 8.0: https://www.qnx.com/developers/docs/8.0/com.qnx.doc.neutrino.utilities/topic/q/qcc.html
2134                    // This assumes qcc/q++ as compiler, which is currently the only supported compiler for QNX.
2135                    // See for details: https://github.com/rust-lang/cc-rs/pull/1319
2136                    let arg = match target.full_arch {
2137                        "x86" | "i586" => "-Vgcc_ntox86_cxx",
2138                        "aarch64" => "-Vgcc_ntoaarch64le_cxx",
2139                        "x86_64" => "-Vgcc_ntox86_64_cxx",
2140                        _ => {
2141                            return Err(Error::new(
2142                                ErrorKind::InvalidTarget,
2143                                format!("Unknown architecture for Neutrino QNX: {}", target.arch),
2144                            ))
2145                        }
2146                    };
2147                    cmd.push_cc_arg(arg.into());
2148                }
2149            }
2150        }
2151
2152        if self.get_debug() {
2153            if self.cuda {
2154                // NVCC debug flag
2155                cmd.args.push("-G".into());
2156            }
2157            let family = cmd.family;
2158            family.add_debug_flags(cmd, self.get_dwarf_version());
2159        }
2160
2161        if self.get_force_frame_pointer() {
2162            let family = cmd.family;
2163            family.add_force_frame_pointer(cmd);
2164        }
2165
2166        if !cmd.is_like_msvc() {
2167            if target.arch == "x86" {
2168                cmd.args.push("-m32".into());
2169            } else if target.abi == "x32" {
2170                cmd.args.push("-mx32".into());
2171            } else if target.os == "aix" {
2172                if cmd.family == ToolFamily::Gnu {
2173                    cmd.args.push("-maix64".into());
2174                } else {
2175                    cmd.args.push("-m64".into());
2176                }
2177            } else if target.arch == "x86_64" || target.arch == "powerpc64" {
2178                cmd.args.push("-m64".into());
2179            }
2180        }
2181
2182        // Target flags
2183        match cmd.family {
2184            ToolFamily::Clang { .. } => {
2185                if !(cmd.has_internal_target_arg
2186                    || (target.os == "android"
2187                        && android_clang_compiler_uses_target_arg_internally(&cmd.path)))
2188                {
2189                    if target.os == "freebsd" {
2190                        // FreeBSD only supports C++11 and above when compiling against libc++
2191                        // (available from FreeBSD 10 onwards). Under FreeBSD, clang uses libc++ by
2192                        // default on FreeBSD 10 and newer unless `--target` is manually passed to
2193                        // the compiler, in which case its default behavior differs:
2194                        // * If --target=xxx-unknown-freebsdX(.Y) is specified and X is greater than
2195                        //   or equal to 10, clang++ uses libc++
2196                        // * If --target=xxx-unknown-freebsd is specified (without a version),
2197                        //   clang++ cannot assume libc++ is available and reverts to a default of
2198                        //   libstdc++ (this behavior was changed in llvm 14).
2199                        //
2200                        // This breaks C++11 (or greater) builds if targeting FreeBSD with the
2201                        // generic xxx-unknown-freebsd target on clang 13 or below *without*
2202                        // explicitly specifying that libc++ should be used.
2203                        // When cross-compiling, we can't infer from the rust/cargo target name
2204                        // which major version of FreeBSD we are targeting, so we need to make sure
2205                        // that libc++ is used (unless the user has explicitly specified otherwise).
2206                        // There's no compelling reason to use a different approach when compiling
2207                        // natively.
2208                        if self.cpp && self.cpp_set_stdlib.is_none() {
2209                            cmd.push_cc_arg("-stdlib=libc++".into());
2210                        }
2211                    } else if target.arch == "wasm32" && target.os == "linux" {
2212                        for x in &[
2213                            "atomics",
2214                            "bulk-memory",
2215                            "mutable-globals",
2216                            "sign-ext",
2217                            "exception-handling",
2218                        ] {
2219                            cmd.push_cc_arg(format!("-m{x}").into());
2220                        }
2221                        for x in &["wasm-exceptions", "declspec"] {
2222                            cmd.push_cc_arg(format!("-f{x}").into());
2223                        }
2224                        let musl_sysroot = self.wasm_musl_sysroot().unwrap();
2225                        cmd.push_cc_arg(
2226                            format!("--sysroot={}", Path::new(&musl_sysroot).display()).into(),
2227                        );
2228                        cmd.push_cc_arg("-pthread".into());
2229                    }
2230                    // Pass `--target` with the LLVM target to configure Clang for cross-compiling.
2231                    //
2232                    // This is **required** for cross-compilation, as it's the only flag that
2233                    // consistently forces Clang to change the "toolchain" that is responsible for
2234                    // parsing target-specific flags:
2235                    // https://github.com/rust-lang/cc-rs/issues/1388
2236                    // https://github.com/llvm/llvm-project/blob/llvmorg-19.1.7/clang/lib/Driver/Driver.cpp#L1359-L1360
2237                    // https://github.com/llvm/llvm-project/blob/llvmorg-19.1.7/clang/lib/Driver/Driver.cpp#L6347-L6532
2238                    //
2239                    // This can be confusing, because on e.g. host macOS, you can usually get by
2240                    // with `-arch` and `-mtargetos=`. But that only works because the _default_
2241                    // toolchain is `Darwin`, which enables parsing of darwin-specific options.
2242                    //
2243                    // NOTE: In the past, we passed the deployment version in here on all Apple
2244                    // targets, but versioned targets were found to have poor compatibility with
2245                    // older versions of Clang, especially when it comes to configuration files:
2246                    // https://github.com/rust-lang/cc-rs/issues/1278
2247                    //
2248                    // So instead, we pass the deployment target with `-m*-version-min=`, and only
2249                    // pass it here on visionOS and Mac Catalyst where that option does not exist:
2250                    // https://github.com/rust-lang/cc-rs/issues/1383
2251                    let version = if target.os == "visionos" || target.env == "macabi" {
2252                        Some(self.apple_deployment_target(target))
2253                    } else {
2254                        None
2255                    };
2256
2257                    let clang_target =
2258                        target.llvm_target(&self.get_raw_target()?, version.as_deref());
2259                    cmd.push_cc_arg(format!("--target={clang_target}").into());
2260                }
2261            }
2262            ToolFamily::Msvc { clang_cl } => {
2263                // This is an undocumented flag from MSVC but helps with making
2264                // builds more reproducible by avoiding putting timestamps into
2265                // files.
2266                cmd.push_cc_arg("-Brepro".into());
2267
2268                if clang_cl {
2269                    if target.arch == "x86_64" {
2270                        cmd.push_cc_arg("-m64".into());
2271                    } else if target.arch == "x86" {
2272                        cmd.push_cc_arg("-m32".into());
2273                        // See
2274                        // <https://learn.microsoft.com/en-us/cpp/build/reference/arch-x86?view=msvc-170>.
2275                        //
2276                        // NOTE: Rust officially supported Windows targets all require SSE2 as part
2277                        // of baseline target features.
2278                        //
2279                        // NOTE: The same applies for STL. See: -
2280                        // <https://github.com/microsoft/STL/issues/3922>, and -
2281                        // <https://github.com/microsoft/STL/pull/4741>.
2282                        cmd.push_cc_arg("-arch:SSE2".into());
2283                    } else {
2284                        cmd.push_cc_arg(
2285                            format!(
2286                                "--target={}",
2287                                target.llvm_target(&self.get_raw_target()?, None)
2288                            )
2289                            .into(),
2290                        );
2291                    }
2292                } else if target.full_arch == "i586" {
2293                    cmd.push_cc_arg("-arch:IA32".into());
2294                } else if target.full_arch == "arm64ec" {
2295                    cmd.push_cc_arg("-arm64EC".into());
2296                }
2297                // There is a check in corecrt.h that will generate a
2298                // compilation error if
2299                // _ARM_WINAPI_PARTITION_DESKTOP_SDK_AVAILABLE is
2300                // not defined to 1. The check was added in Windows
2301                // 8 days because only store apps were allowed on ARM.
2302                // This changed with the release of Windows 10 IoT Core.
2303                // The check will be going away in future versions of
2304                // the SDK, but for all released versions of the
2305                // Windows SDK it is required.
2306                if target.arch == "arm" {
2307                    cmd.args
2308                        .push("-D_ARM_WINAPI_PARTITION_DESKTOP_SDK_AVAILABLE=1".into());
2309                }
2310            }
2311            ToolFamily::Gnu => {
2312                if target.vendor == "kmc" {
2313                    cmd.args.push("-finput-charset=utf-8".into());
2314                }
2315
2316                if self.static_flag.is_none() {
2317                    let features = self.getenv("CARGO_CFG_TARGET_FEATURE");
2318                    let features = features.as_deref().unwrap_or_default();
2319                    if features.to_string_lossy().contains("crt-static") {
2320                        cmd.args.push("-static".into());
2321                    }
2322                }
2323
2324                // armv7 targets get to use armv7 instructions
2325                if (target.full_arch.starts_with("armv7")
2326                    || target.full_arch.starts_with("thumbv7"))
2327                    && (target.os == "linux" || target.vendor == "kmc")
2328                {
2329                    cmd.args.push("-march=armv7-a".into());
2330
2331                    if target.abi == "eabihf" {
2332                        // lowest common denominator FPU
2333                        cmd.args.push("-mfpu=vfpv3-d16".into());
2334                        cmd.args.push("-mfloat-abi=hard".into());
2335                    }
2336                }
2337
2338                // (x86 Android doesn't say "eabi")
2339                if target.os == "android" && target.full_arch.contains("v7") {
2340                    cmd.args.push("-march=armv7-a".into());
2341                    cmd.args.push("-mthumb".into());
2342                    if !target.full_arch.contains("neon") {
2343                        // On android we can guarantee some extra float instructions
2344                        // (specified in the android spec online)
2345                        // NEON guarantees even more; see below.
2346                        cmd.args.push("-mfpu=vfpv3-d16".into());
2347                    }
2348                    cmd.args.push("-mfloat-abi=softfp".into());
2349                }
2350
2351                if target.full_arch.contains("neon") {
2352                    cmd.args.push("-mfpu=neon-vfpv4".into());
2353                }
2354
2355                if target.full_arch == "armv4t" && target.os == "linux" {
2356                    cmd.args.push("-march=armv4t".into());
2357                    cmd.args.push("-marm".into());
2358                    cmd.args.push("-mfloat-abi=soft".into());
2359                }
2360
2361                if target.full_arch == "armv5te" && target.os == "linux" {
2362                    cmd.args.push("-march=armv5te".into());
2363                    cmd.args.push("-marm".into());
2364                    cmd.args.push("-mfloat-abi=soft".into());
2365                }
2366
2367                // For us arm == armv6 by default
2368                if target.full_arch == "arm" && target.os == "linux" {
2369                    cmd.args.push("-march=armv6".into());
2370                    cmd.args.push("-marm".into());
2371                    if target.abi == "eabihf" {
2372                        cmd.args.push("-mfpu=vfp".into());
2373                    } else {
2374                        cmd.args.push("-mfloat-abi=soft".into());
2375                    }
2376                }
2377
2378                // Turn codegen down on i586 to avoid some instructions.
2379                if target.full_arch == "i586" && target.os == "linux" {
2380                    cmd.args.push("-march=pentium".into());
2381                }
2382
2383                // Set codegen level for i686 correctly
2384                if target.full_arch == "i686" && target.os == "linux" {
2385                    cmd.args.push("-march=i686".into());
2386                }
2387
2388                // Looks like `musl-gcc` makes it hard for `-m32` to make its way
2389                // all the way to the linker, so we need to actually instruct the
2390                // linker that we're generating 32-bit executables as well. This'll
2391                // typically only be used for build scripts which transitively use
2392                // these flags that try to compile executables.
2393                if target.arch == "x86" && target.env == "musl" {
2394                    cmd.args.push("-Wl,-melf_i386".into());
2395                }
2396
2397                if target.arch == "arm" && target.os == "none" && target.abi == "eabihf" {
2398                    cmd.args.push("-mfloat-abi=hard".into())
2399                }
2400                if target.full_arch.starts_with("thumb") {
2401                    cmd.args.push("-mthumb".into());
2402                }
2403                if target.full_arch.starts_with("thumbv6m") {
2404                    cmd.args.push("-march=armv6s-m".into());
2405                }
2406                if target.full_arch.starts_with("thumbv7em") {
2407                    cmd.args.push("-march=armv7e-m".into());
2408
2409                    if target.abi == "eabihf" {
2410                        cmd.args.push("-mfpu=fpv4-sp-d16".into())
2411                    }
2412                }
2413                if target.full_arch.starts_with("thumbv7m") {
2414                    cmd.args.push("-march=armv7-m".into());
2415                }
2416                if target.full_arch.starts_with("thumbv8m.base") {
2417                    cmd.args.push("-march=armv8-m.base".into());
2418                }
2419                if target.full_arch.starts_with("thumbv8m.main") {
2420                    cmd.args.push("-march=armv8-m.main".into());
2421
2422                    if target.abi == "eabihf" {
2423                        cmd.args.push("-mfpu=fpv5-sp-d16".into())
2424                    }
2425                }
2426                if target.full_arch.starts_with("armebv7r") | target.full_arch.starts_with("armv7r")
2427                {
2428                    if target.full_arch.starts_with("armeb") {
2429                        cmd.args.push("-mbig-endian".into());
2430                    } else {
2431                        cmd.args.push("-mlittle-endian".into());
2432                    }
2433
2434                    // ARM mode
2435                    cmd.args.push("-marm".into());
2436
2437                    // R Profile
2438                    cmd.args.push("-march=armv7-r".into());
2439
2440                    if target.abi == "eabihf" {
2441                        // lowest common denominator FPU
2442                        // (see Cortex-R4 technical reference manual)
2443                        cmd.args.push("-mfpu=vfpv3-d16".into())
2444                    }
2445                }
2446                if target.full_arch.starts_with("armv7a") {
2447                    cmd.args.push("-march=armv7-a".into());
2448
2449                    if target.abi == "eabihf" {
2450                        // lowest common denominator FPU
2451                        cmd.args.push("-mfpu=vfpv3-d16".into());
2452                    }
2453                }
2454                if target.arch == "riscv32" || target.arch == "riscv64" {
2455                    // get the 32i/32imac/32imc/64gc/64imac/... part
2456                    let arch = &target.full_arch[5..];
2457                    if arch.starts_with("64") {
2458                        if matches!(target.os, "linux" | "freebsd" | "netbsd") {
2459                            cmd.args.push(("-march=rv64gc").into());
2460                            cmd.args.push("-mabi=lp64d".into());
2461                        } else {
2462                            cmd.args.push(("-march=rv".to_owned() + arch).into());
2463                            cmd.args.push("-mabi=lp64".into());
2464                        }
2465                    } else if arch.starts_with("32") {
2466                        if target.os == "linux" {
2467                            cmd.args.push(("-march=rv32gc").into());
2468                            cmd.args.push("-mabi=ilp32d".into());
2469                        } else {
2470                            cmd.args.push(("-march=rv".to_owned() + arch).into());
2471                            cmd.args.push("-mabi=ilp32".into());
2472                        }
2473                    } else {
2474                        cmd.args.push("-mcmodel=medany".into());
2475                    }
2476                }
2477            }
2478        }
2479
2480        if raw_target == "wasm32v1-none" {
2481            // `wasm32v1-none` target only exists in `rustc`, so we need to change the compilation flags:
2482            // https://doc.rust-lang.org/rustc/platform-support/wasm32v1-none.html
2483            cmd.push_cc_arg("-mcpu=mvp".into());
2484            cmd.push_cc_arg("-mmutable-globals".into());
2485        }
2486
2487        if target.os == "solaris" || target.os == "illumos" {
2488            // On Solaris and illumos, multi-threaded C programs must be built with `_REENTRANT`
2489            // defined. This configures headers to define APIs appropriately for multi-threaded
2490            // use. This is documented in threads(7), see also https://illumos.org/man/7/threads.
2491            //
2492            // If C code is compiled without multi-threading support but does use multiple threads,
2493            // incorrect behavior may result. One extreme example is that on some systems the
2494            // global errno may be at the same address as the process' first thread's errno; errno
2495            // clobbering may occur to disastrous effect. Conversely, if _REENTRANT is defined
2496            // while it is not actually needed, system headers may define some APIs suboptimally
2497            // but will not result in incorrect behavior. Other code *should* be reasonable under
2498            // such conditions.
2499            //
2500            // We're typically building C code to eventually link into a Rust program. Many Rust
2501            // programs are multi-threaded in some form. So, set the flag by default.
2502            cmd.args.push("-D_REENTRANT".into());
2503        }
2504
2505        if target.vendor == "apple" {
2506            self.apple_flags(cmd)?;
2507        }
2508
2509        if self.static_flag.unwrap_or(false) {
2510            cmd.args.push("-static".into());
2511        }
2512        if self.shared_flag.unwrap_or(false) {
2513            cmd.args.push("-shared".into());
2514        }
2515
2516        if self.cpp {
2517            match (self.cpp_set_stdlib.as_ref(), cmd.family) {
2518                (None, _) => {}
2519                (Some(stdlib), ToolFamily::Gnu) | (Some(stdlib), ToolFamily::Clang { .. }) => {
2520                    cmd.push_cc_arg(format!("-stdlib=lib{stdlib}").into());
2521                }
2522                _ => {
2523                    self.cargo_output.print_warning(&format_args!("cpp_set_stdlib is specified, but the {:?} compiler does not support this option, ignored", cmd.family));
2524                }
2525            }
2526        }
2527
2528        Ok(())
2529    }
2530
2531    fn add_inherited_rustflags(
2532        &self,
2533        cmd: &mut Tool,
2534        target: &TargetInfo<'_>,
2535    ) -> Result<(), Error> {
2536        let env_os = match self.getenv("CARGO_ENCODED_RUSTFLAGS") {
2537            Some(env) => env,
2538            // No encoded RUSTFLAGS -> nothing to do
2539            None => return Ok(()),
2540        };
2541
2542        let env = env_os.to_string_lossy();
2543        let codegen_flags = RustcCodegenFlags::parse(&env)?;
2544        codegen_flags.cc_flags(self, cmd, target);
2545        Ok(())
2546    }
2547
2548    fn msvc_macro_assembler(&self) -> Result<Command, Error> {
2549        let target = self.get_target()?;
2550        let tool = match target.arch {
2551            "x86_64" => "ml64.exe",
2552            "arm" => "armasm.exe",
2553            "aarch64" | "arm64ec" => "armasm64.exe",
2554            _ => "ml.exe",
2555        };
2556        let mut cmd = self
2557            .find_msvc_tools_find(&target, tool)
2558            .unwrap_or_else(|| self.cmd(tool));
2559        cmd.arg("-nologo"); // undocumented, yet working with armasm[64]
2560        for directory in self.include_directories.iter() {
2561            cmd.arg("-I").arg(&**directory);
2562        }
2563        if is_arm(&target) {
2564            if self.get_debug() {
2565                cmd.arg("-g");
2566            }
2567
2568            if target.arch == "arm64ec" {
2569                cmd.args(["-machine", "ARM64EC"]);
2570            }
2571
2572            for (key, value) in self.definitions.iter() {
2573                cmd.arg("-PreDefine");
2574                if let Some(ref value) = *value {
2575                    if let Ok(i) = value.parse::<i32>() {
2576                        cmd.arg(format!("{key} SETA {i}"));
2577                    } else if value.starts_with('"') && value.ends_with('"') {
2578                        cmd.arg(format!("{key} SETS {value}"));
2579                    } else {
2580                        cmd.arg(format!("{key} SETS \"{value}\""));
2581                    }
2582                } else {
2583                    cmd.arg(format!("{} SETL {}", key, "{TRUE}"));
2584                }
2585            }
2586        } else {
2587            if self.get_debug() {
2588                cmd.arg("-Zi");
2589            }
2590
2591            for (key, value) in self.definitions.iter() {
2592                if let Some(ref value) = *value {
2593                    cmd.arg(format!("-D{key}={value}"));
2594                } else {
2595                    cmd.arg(format!("-D{key}"));
2596                }
2597            }
2598        }
2599
2600        if target.arch == "x86" {
2601            cmd.arg("-safeseh");
2602        }
2603
2604        Ok(cmd)
2605    }
2606
2607    fn assemble(&self, lib_name: &str, dst: &Path, objs: &[Object]) -> Result<(), Error> {
2608        // Delete the destination if it exists as we want to
2609        // create on the first iteration instead of appending.
2610        let _ = fs::remove_file(dst);
2611
2612        // Add objects to the archive in limited-length batches. This helps keep
2613        // the length of the command line within a reasonable length to avoid
2614        // blowing system limits on limiting platforms like Windows.
2615        let objs: Vec<_> = objs
2616            .iter()
2617            .map(|o| o.dst.as_path())
2618            .chain(self.objects.iter().map(std::ops::Deref::deref))
2619            .collect();
2620        for chunk in objs.chunks(100) {
2621            self.assemble_progressive(dst, chunk)?;
2622        }
2623
2624        if self.cuda && self.cuda_file_count() > 0 {
2625            // Link the device-side code and add it to the target library,
2626            // so that non-CUDA linker can link the final binary.
2627
2628            let out_dir = self.get_out_dir()?;
2629            let dlink = out_dir.join(lib_name.to_owned() + "_dlink.o");
2630            let mut nvcc = self.get_compiler().to_command();
2631            nvcc.arg("--device-link").arg("-o").arg(&dlink).arg(dst);
2632            run(&mut nvcc, &self.cargo_output)?;
2633            self.assemble_progressive(dst, &[dlink.as_path()])?;
2634        }
2635
2636        let target = self.get_target()?;
2637        if target.env == "msvc" {
2638            // The Rust compiler will look for libfoo.a and foo.lib, but the
2639            // MSVC linker will also be passed foo.lib, so be sure that both
2640            // exist for now.
2641
2642            let lib_dst = dst.with_file_name(format!("{lib_name}.lib"));
2643            let _ = fs::remove_file(&lib_dst);
2644            match fs::hard_link(dst, &lib_dst).or_else(|_| {
2645                // if hard-link fails, just copy (ignoring the number of bytes written)
2646                fs::copy(dst, &lib_dst).map(|_| ())
2647            }) {
2648                Ok(_) => (),
2649                Err(_) => {
2650                    return Err(Error::new(
2651                        ErrorKind::IOError,
2652                        "Could not copy or create a hard-link to the generated lib file.",
2653                    ));
2654                }
2655            };
2656        } else {
2657            // Non-msvc targets (those using `ar`) need a separate step to add
2658            // the symbol table to archives since our construction command of
2659            // `cq` doesn't add it for us.
2660            let mut ar = self.try_get_archiver()?;
2661
2662            // NOTE: We add `s` even if flags were passed using $ARFLAGS/ar_flag, because `s`
2663            // here represents a _mode_, not an arbitrary flag. Further discussion of this choice
2664            // can be seen in https://github.com/rust-lang/cc-rs/pull/763.
2665            run(ar.arg("s").arg(dst), &self.cargo_output)?;
2666        }
2667
2668        Ok(())
2669    }
2670
2671    fn assemble_progressive(&self, dst: &Path, objs: &[&Path]) -> Result<(), Error> {
2672        let target = self.get_target()?;
2673
2674        let (mut cmd, program, any_flags) = self.try_get_archiver_and_flags()?;
2675        if target.env == "msvc" && !program.to_string_lossy().contains("llvm-ar") {
2676            // NOTE: -out: here is an I/O flag, and so must be included even if $ARFLAGS/ar_flag is
2677            // in use. -nologo on the other hand is just a regular flag, and one that we'll skip if
2678            // the caller has explicitly dictated the flags they want. See
2679            // https://github.com/rust-lang/cc-rs/pull/763 for further discussion.
2680            let mut out = OsString::from("-out:");
2681            out.push(dst);
2682            cmd.arg(out);
2683            if !any_flags {
2684                cmd.arg("-nologo");
2685            }
2686            // If the library file already exists, add the library name
2687            // as an argument to let lib.exe know we are appending the objs.
2688            if dst.exists() {
2689                cmd.arg(dst);
2690            }
2691            cmd.args(objs);
2692            run(&mut cmd, &self.cargo_output)?;
2693        } else {
2694            // Set an environment variable to tell the OSX archiver to ensure
2695            // that all dates listed in the archive are zero, improving
2696            // determinism of builds. AFAIK there's not really official
2697            // documentation of this but there's a lot of references to it if
2698            // you search google.
2699            //
2700            // You can reproduce this locally on a mac with:
2701            //
2702            //      $ touch foo.c
2703            //      $ cc -c foo.c -o foo.o
2704            //
2705            //      # Notice that these two checksums are different
2706            //      $ ar crus libfoo1.a foo.o && sleep 2 && ar crus libfoo2.a foo.o
2707            //      $ md5sum libfoo*.a
2708            //
2709            //      # Notice that these two checksums are the same
2710            //      $ export ZERO_AR_DATE=1
2711            //      $ ar crus libfoo1.a foo.o && sleep 2 && touch foo.o && ar crus libfoo2.a foo.o
2712            //      $ md5sum libfoo*.a
2713            //
2714            // In any case if this doesn't end up getting read, it shouldn't
2715            // cause that many issues!
2716            cmd.env("ZERO_AR_DATE", "1");
2717
2718            // NOTE: We add cq here regardless of whether $ARFLAGS/ar_flag have been used because
2719            // it dictates the _mode_ ar runs in, which the setter of $ARFLAGS/ar_flag can't
2720            // dictate. See https://github.com/rust-lang/cc-rs/pull/763 for further discussion.
2721            run(cmd.arg("cq").arg(dst).args(objs), &self.cargo_output)?;
2722        }
2723
2724        Ok(())
2725    }
2726
2727    fn apple_flags(&self, cmd: &mut Tool) -> Result<(), Error> {
2728        let target = self.get_target()?;
2729
2730        // This is a Darwin/Apple-specific flag that works both on GCC and Clang, but it is only
2731        // necessary on GCC since we specify `-target` on Clang.
2732        // https://gcc.gnu.org/onlinedocs/gcc/Darwin-Options.html#:~:text=arch
2733        // https://clang.llvm.org/docs/CommandGuide/clang.html#cmdoption-arch
2734        if cmd.is_like_gnu() {
2735            let arch = map_darwin_target_from_rust_to_compiler_architecture(&target);
2736            cmd.args.push("-arch".into());
2737            cmd.args.push(arch.into());
2738        }
2739
2740        // Pass the deployment target via `-mmacosx-version-min=`, `-miphoneos-version-min=` and
2741        // similar. Also necessary on GCC, as it forces a compilation error if the compiler is not
2742        // configured for Darwin: https://gcc.gnu.org/onlinedocs/gcc/Darwin-Options.html
2743        //
2744        // On visionOS and Mac Catalyst, there is no -m*-version-min= flag:
2745        // https://github.com/llvm/llvm-project/issues/88271
2746        // And the workaround to use `-mtargetos=` cannot be used with the `--target` flag that we
2747        // otherwise specify. So we avoid emitting that, and put the version in `--target` instead.
2748        if cmd.is_like_gnu() || !(target.os == "visionos" || target.env == "macabi") {
2749            let min_version = self.apple_deployment_target(&target);
2750            cmd.args
2751                .push(target.apple_version_flag(&min_version).into());
2752        }
2753
2754        // AppleClang sometimes requires sysroot even on macOS
2755        if cmd.is_xctoolchain_clang() || target.os != "macos" {
2756            self.cargo_output.print_metadata(&format_args!(
2757                "Detecting {:?} SDK path for {}",
2758                target.os,
2759                target.apple_sdk_name(),
2760            ));
2761            let sdk_path = self.apple_sdk_root(&target)?;
2762
2763            cmd.args.push("-isysroot".into());
2764            cmd.args.push(OsStr::new(&sdk_path).to_owned());
2765            cmd.env
2766                .push(("SDKROOT".into(), OsStr::new(&sdk_path).to_owned()));
2767
2768            if target.env == "macabi" {
2769                // Mac Catalyst uses the macOS SDK, but to compile against and
2770                // link to iOS-specific frameworks, we should have the support
2771                // library stubs in the include and library search path.
2772                let ios_support = Path::new(&sdk_path).join("System/iOSSupport");
2773
2774                cmd.args.extend([
2775                    // Header search path
2776                    OsString::from("-isystem"),
2777                    ios_support.join("usr/include").into(),
2778                    // Framework header search path
2779                    OsString::from("-iframework"),
2780                    ios_support.join("System/Library/Frameworks").into(),
2781                    // Library search path
2782                    {
2783                        let mut s = OsString::from("-L");
2784                        s.push(ios_support.join("usr/lib"));
2785                        s
2786                    },
2787                    // Framework linker search path
2788                    {
2789                        // Technically, we _could_ avoid emitting `-F`, as
2790                        // `-iframework` implies it, but let's keep it in for
2791                        // clarity.
2792                        let mut s = OsString::from("-F");
2793                        s.push(ios_support.join("System/Library/Frameworks"));
2794                        s
2795                    },
2796                ]);
2797            }
2798        }
2799
2800        Ok(())
2801    }
2802
2803    fn cmd<P: AsRef<OsStr>>(&self, prog: P) -> Command {
2804        let mut cmd = Command::new(prog);
2805        for (a, b) in self.env.iter() {
2806            cmd.env(a, b);
2807        }
2808        cmd
2809    }
2810
2811    fn prefer_clang(&self) -> bool {
2812        if let Some(env) = self.getenv("CARGO_ENCODED_RUSTFLAGS") {
2813            env.to_string_lossy().contains("linker-plugin-lto")
2814        } else {
2815            false
2816        }
2817    }
2818
2819    fn get_base_compiler(&self) -> Result<Tool, Error> {
2820        let out_dir = self.get_out_dir().ok();
2821        let out_dir = out_dir.as_deref();
2822
2823        if let Some(c) = &self.compiler {
2824            return Ok(Tool::new(
2825                (**c).to_owned(),
2826                &self.build_cache.cached_compiler_family,
2827                &self.cargo_output,
2828                out_dir,
2829            ));
2830        }
2831        let target = self.get_target()?;
2832        let raw_target = self.get_raw_target()?;
2833
2834        let msvc = if self.prefer_clang_cl_over_msvc {
2835            "clang-cl.exe"
2836        } else {
2837            "cl.exe"
2838        };
2839
2840        let (env, gnu, traditional, clang) = if self.cpp {
2841            ("CXX", "g++", "c++", "clang++")
2842        } else {
2843            ("CC", "gcc", "cc", "clang")
2844        };
2845
2846        let fallback = Cow::Borrowed(Path::new(traditional));
2847        let default = if cfg!(target_os = "solaris") || cfg!(target_os = "illumos") {
2848            // On historical Solaris systems, "cc" may have been Sun Studio, which
2849            // is not flag-compatible with "gcc".  This history casts a long shadow,
2850            // and many modern illumos distributions today ship GCC as "gcc" without
2851            // also making it available as "cc".
2852            Cow::Borrowed(Path::new(gnu))
2853        } else if self.prefer_clang() {
2854            self.which(Path::new(clang), None)
2855                .map(Cow::Owned)
2856                .unwrap_or(fallback)
2857        } else {
2858            fallback
2859        };
2860
2861        let cl_exe = self.find_msvc_tools_find_tool(&target, msvc);
2862
2863        let tool_opt: Option<Tool> = self
2864            .env_tool(env)
2865            .map(|(tool, wrapper, args)| {
2866                // Chop off leading/trailing whitespace to work around
2867                // semi-buggy build scripts which are shared in
2868                // makefiles/configure scripts (where spaces are far more
2869                // lenient)
2870                let mut t = Tool::with_args(
2871                    tool,
2872                    args.clone(),
2873                    &self.build_cache.cached_compiler_family,
2874                    &self.cargo_output,
2875                    out_dir,
2876                );
2877                if let Some(cc_wrapper) = wrapper {
2878                    t.cc_wrapper_path = Some(Path::new(&cc_wrapper).to_owned());
2879                }
2880                for arg in args {
2881                    t.cc_wrapper_args.push(arg.into());
2882                }
2883                t
2884            })
2885            .or_else(|| {
2886                if target.os == "emscripten" {
2887                    let tool = if self.cpp { "em++" } else { "emcc" };
2888                    // Windows uses bat file so we have to be a bit more specific
2889                    if cfg!(windows) {
2890                        let mut t = Tool::with_family(
2891                            PathBuf::from("cmd"),
2892                            ToolFamily::Clang { zig_cc: false },
2893                        );
2894                        t.args.push("/c".into());
2895                        t.args.push(format!("{tool}.bat").into());
2896                        Some(t)
2897                    } else {
2898                        Some(Tool::new(
2899                            PathBuf::from(tool),
2900                            &self.build_cache.cached_compiler_family,
2901                            &self.cargo_output,
2902                            out_dir,
2903                        ))
2904                    }
2905                } else {
2906                    None
2907                }
2908            })
2909            .or_else(|| cl_exe.clone());
2910
2911        let tool = match tool_opt {
2912            Some(t) => t,
2913            None => {
2914                let compiler: PathBuf = if cfg!(windows) && target.os == "windows" {
2915                    if target.env == "msvc" {
2916                        msvc.into()
2917                    } else {
2918                        let cc = if target.abi == "llvm" { clang } else { gnu };
2919                        format!("{cc}.exe").into()
2920                    }
2921                } else if target.os == "ios"
2922                    || target.os == "watchos"
2923                    || target.os == "tvos"
2924                    || target.os == "visionos"
2925                {
2926                    clang.into()
2927                } else if target.os == "android" {
2928                    autodetect_android_compiler(&raw_target, gnu, clang)
2929                } else if target.os == "cloudabi" {
2930                    format!(
2931                        "{}-{}-{}-{}",
2932                        target.full_arch, target.vendor, target.os, traditional
2933                    )
2934                    .into()
2935                } else if target.os == "wasi" {
2936                    self.autodetect_wasi_compiler(&raw_target, clang)
2937                } else if target.arch == "wasm32" || target.arch == "wasm64" {
2938                    // Compiling WASM is not currently supported by GCC, so
2939                    // let's default to Clang.
2940                    clang.into()
2941                } else if target.os == "vxworks" {
2942                    if self.cpp { "wr-c++" } else { "wr-cc" }.into()
2943                } else if target.arch == "arm" && target.vendor == "kmc" {
2944                    format!("arm-kmc-eabi-{gnu}").into()
2945                } else if target.arch == "aarch64" && target.vendor == "kmc" {
2946                    format!("aarch64-kmc-elf-{gnu}").into()
2947                } else if target.os == "nto" {
2948                    // See for details: https://github.com/rust-lang/cc-rs/pull/1319
2949                    if self.cpp { "q++" } else { "qcc" }.into()
2950                } else if self.get_is_cross_compile()? {
2951                    let prefix = self.prefix_for_target(&raw_target);
2952                    match prefix {
2953                        Some(prefix) => {
2954                            let cc = if target.abi == "llvm" { clang } else { gnu };
2955                            format!("{prefix}-{cc}").into()
2956                        }
2957                        None => default.into(),
2958                    }
2959                } else {
2960                    default.into()
2961                };
2962
2963                let mut t = Tool::new(
2964                    compiler,
2965                    &self.build_cache.cached_compiler_family,
2966                    &self.cargo_output,
2967                    out_dir,
2968                );
2969                if let Some(cc_wrapper) = self.rustc_wrapper_fallback() {
2970                    t.cc_wrapper_path = Some(Path::new(&cc_wrapper).to_owned());
2971                }
2972                t
2973            }
2974        };
2975
2976        let mut tool = if self.cuda {
2977            assert!(
2978                tool.args.is_empty(),
2979                "CUDA compilation currently assumes empty pre-existing args"
2980            );
2981            let nvcc = match self.getenv_with_target_prefixes("NVCC") {
2982                Err(_) => PathBuf::from("nvcc"),
2983                Ok(nvcc) => PathBuf::from(&*nvcc),
2984            };
2985            let mut nvcc_tool = Tool::with_features(
2986                nvcc,
2987                vec![],
2988                self.cuda,
2989                &self.build_cache.cached_compiler_family,
2990                &self.cargo_output,
2991                out_dir,
2992            );
2993            if self.ccbin {
2994                nvcc_tool
2995                    .args
2996                    .push(format!("-ccbin={}", tool.path.display()).into());
2997            }
2998            if let Some(cc_wrapper) = self.rustc_wrapper_fallback() {
2999                nvcc_tool.cc_wrapper_path = Some(Path::new(&cc_wrapper).to_owned());
3000            }
3001            nvcc_tool.family = tool.family;
3002            nvcc_tool
3003        } else {
3004            tool
3005        };
3006
3007        // New "standalone" C/C++ cross-compiler executables from recent Android NDK
3008        // are just shell scripts that call main clang binary (from Android NDK) with
3009        // proper `--target` argument.
3010        //
3011        // For example, armv7a-linux-androideabi16-clang passes
3012        // `--target=armv7a-linux-androideabi16` to clang.
3013        //
3014        // As the shell script calls the main clang binary, the command line limit length
3015        // on Windows is restricted to around 8k characters instead of around 32k characters.
3016        // To remove this limit, we call the main clang binary directly and construct the
3017        // `--target=` ourselves.
3018        if cfg!(windows) && android_clang_compiler_uses_target_arg_internally(&tool.path) {
3019            if let Some(path) = tool.path.file_name() {
3020                let file_name = path.to_str().unwrap().to_owned();
3021                let (target, clang) = file_name.split_at(file_name.rfind('-').unwrap());
3022
3023                tool.has_internal_target_arg = true;
3024                tool.path.set_file_name(clang.trim_start_matches('-'));
3025                tool.path.set_extension("exe");
3026                tool.args.push(format!("--target={target}").into());
3027
3028                // Additionally, shell scripts for target i686-linux-android versions 16 to 24
3029                // pass the `mstackrealign` option so we do that here as well.
3030                if target.contains("i686-linux-android") {
3031                    let (_, version) = target.split_at(target.rfind('d').unwrap() + 1);
3032                    if let Ok(version) = version.parse::<u32>() {
3033                        if version > 15 && version < 25 {
3034                            tool.args.push("-mstackrealign".into());
3035                        }
3036                    }
3037                }
3038            };
3039        }
3040
3041        // If we found `cl.exe` in our environment, the tool we're returning is
3042        // an MSVC-like tool, *and* no env vars were set then set env vars for
3043        // the tool that we're returning.
3044        //
3045        // Env vars are needed for things like `link.exe` being put into PATH as
3046        // well as header include paths sometimes. These paths are automatically
3047        // included by default but if the `CC` or `CXX` env vars are set these
3048        // won't be used. This'll ensure that when the env vars are used to
3049        // configure for invocations like `clang-cl` we still get a "works out
3050        // of the box" experience.
3051        if let Some(cl_exe) = cl_exe {
3052            if tool.family == (ToolFamily::Msvc { clang_cl: true })
3053                && tool.env.is_empty()
3054                && target.env == "msvc"
3055            {
3056                for (k, v) in cl_exe.env.iter() {
3057                    tool.env.push((k.to_owned(), v.to_owned()));
3058                }
3059            }
3060        }
3061
3062        if target.env == "msvc" && tool.family == ToolFamily::Gnu {
3063            self.cargo_output
3064                .print_warning(&"GNU compiler is not supported for this target");
3065        }
3066
3067        Ok(tool)
3068    }
3069
3070    /// Returns a fallback `cc_compiler_wrapper` by introspecting `RUSTC_WRAPPER`
3071    fn rustc_wrapper_fallback(&self) -> Option<Arc<OsStr>> {
3072        // No explicit CC wrapper was detected, but check if RUSTC_WRAPPER
3073        // is defined and is a build accelerator that is compatible with
3074        // C/C++ compilers (e.g. sccache)
3075        const VALID_WRAPPERS: &[&str] = &["sccache", "cachepot", "buildcache"];
3076
3077        let rustc_wrapper = self.getenv("RUSTC_WRAPPER")?;
3078        let wrapper_path = Path::new(&rustc_wrapper);
3079        let wrapper_stem = wrapper_path.file_stem()?;
3080
3081        if VALID_WRAPPERS.contains(&wrapper_stem.to_str()?) {
3082            Some(rustc_wrapper)
3083        } else {
3084            None
3085        }
3086    }
3087
3088    /// Returns compiler path, optional modifier name from whitelist, and arguments vec
3089    fn env_tool(&self, name: &str) -> Option<(PathBuf, Option<Arc<OsStr>>, Vec<String>)> {
3090        let tool = self.getenv_with_target_prefixes(name).ok()?;
3091        let tool = tool.to_string_lossy();
3092        let tool = tool.trim();
3093
3094        if tool.is_empty() {
3095            return None;
3096        }
3097
3098        // If this is an exact path on the filesystem we don't want to do any
3099        // interpretation at all, just pass it on through. This'll hopefully get
3100        // us to support spaces-in-paths.
3101        if Path::new(tool).exists() {
3102            return Some((
3103                PathBuf::from(tool),
3104                self.rustc_wrapper_fallback(),
3105                Vec::new(),
3106            ));
3107        }
3108
3109        // Ok now we want to handle a couple of scenarios. We'll assume from
3110        // here on out that spaces are splitting separate arguments. Two major
3111        // features we want to support are:
3112        //
3113        //      CC='sccache cc'
3114        //
3115        // aka using `sccache` or any other wrapper/caching-like-thing for
3116        // compilations. We want to know what the actual compiler is still,
3117        // though, because our `Tool` API support introspection of it to see
3118        // what compiler is in use.
3119        //
3120        // additionally we want to support
3121        //
3122        //      CC='cc -flag'
3123        //
3124        // where the CC env var is used to also pass default flags to the C
3125        // compiler.
3126        //
3127        // It's true that everything here is a bit of a pain, but apparently if
3128        // you're not literally make or bash then you get a lot of bug reports.
3129        let mut known_wrappers = vec![
3130            "ccache",
3131            "distcc",
3132            "sccache",
3133            "icecc",
3134            "cachepot",
3135            "buildcache",
3136        ];
3137        let custom_wrapper = self.getenv("CC_KNOWN_WRAPPER_CUSTOM");
3138        if custom_wrapper.is_some() {
3139            known_wrappers.push(custom_wrapper.as_deref().unwrap().to_str().unwrap());
3140        }
3141
3142        let mut parts = tool.split_whitespace();
3143        let maybe_wrapper = parts.next()?;
3144
3145        let file_stem = Path::new(maybe_wrapper).file_stem()?.to_str()?;
3146        if known_wrappers.contains(&file_stem) {
3147            if let Some(compiler) = parts.next() {
3148                return Some((
3149                    compiler.into(),
3150                    Some(Arc::<OsStr>::from(OsStr::new(&maybe_wrapper))),
3151                    parts.map(|s| s.to_string()).collect(),
3152                ));
3153            }
3154        }
3155
3156        Some((
3157            maybe_wrapper.into(),
3158            self.rustc_wrapper_fallback(),
3159            parts.map(|s| s.to_string()).collect(),
3160        ))
3161    }
3162
3163    /// Returns the C++ standard library:
3164    /// 1. If [`cpp_link_stdlib`](cc::Build::cpp_link_stdlib) is set, uses its value.
3165    /// 2. Else if the `CXXSTDLIB` environment variable is set, uses its value.
3166    /// 3. Else the default is `c++` for OS X and BSDs, `c++_shared` for Android,
3167    ///    `None` for MSVC and `stdc++` for anything else.
3168    fn get_cpp_link_stdlib(&self) -> Result<Option<Cow<'_, Path>>, Error> {
3169        match &self.cpp_link_stdlib {
3170            Some(s) => Ok(s.as_deref().map(Path::new).map(Cow::Borrowed)),
3171            None => {
3172                if let Ok(stdlib) = self.getenv_with_target_prefixes("CXXSTDLIB") {
3173                    if stdlib.is_empty() {
3174                        Ok(None)
3175                    } else {
3176                        Ok(Some(Cow::Owned(Path::new(&stdlib).to_owned())))
3177                    }
3178                } else {
3179                    let target = self.get_target()?;
3180                    if target.env == "msvc" {
3181                        Ok(None)
3182                    } else if target.vendor == "apple"
3183                        || target.os == "freebsd"
3184                        || target.os == "openbsd"
3185                        || target.os == "aix"
3186                        || (target.os == "linux" && target.env == "ohos")
3187                        || target.os == "wasi"
3188                    {
3189                        Ok(Some(Cow::Borrowed(Path::new("c++"))))
3190                    } else if target.os == "android" {
3191                        Ok(Some(Cow::Borrowed(Path::new("c++_shared"))))
3192                    } else {
3193                        Ok(Some(Cow::Borrowed(Path::new("stdc++"))))
3194                    }
3195                }
3196            }
3197        }
3198    }
3199
3200    /// Get the archiver (ar) that's in use for this configuration.
3201    ///
3202    /// You can use [`Command::get_program`] to get just the path to the command.
3203    ///
3204    /// This method will take into account all configuration such as debug
3205    /// information, optimization level, include directories, defines, etc.
3206    /// Additionally, the compiler binary in use follows the standard
3207    /// conventions for this path, e.g. looking at the explicitly set compiler,
3208    /// environment variables (a number of which are inspected here), and then
3209    /// falling back to the default configuration.
3210    ///
3211    /// # Panics
3212    ///
3213    /// Panics if an error occurred while determining the architecture.
3214    pub fn get_archiver(&self) -> Command {
3215        match self.try_get_archiver() {
3216            Ok(tool) => tool,
3217            Err(e) => fail(&e.message),
3218        }
3219    }
3220
3221    /// Get the archiver that's in use for this configuration.
3222    ///
3223    /// This will return a result instead of panicking;
3224    /// see [`Self::get_archiver`] for the complete description.
3225    pub fn try_get_archiver(&self) -> Result<Command, Error> {
3226        Ok(self.try_get_archiver_and_flags()?.0)
3227    }
3228
3229    fn try_get_archiver_and_flags(&self) -> Result<(Command, PathBuf, bool), Error> {
3230        let (mut cmd, name) = self.get_base_archiver()?;
3231        let mut any_flags = false;
3232        if let Some(flags) = self.envflags("ARFLAGS")? {
3233            any_flags = true;
3234            cmd.args(flags);
3235        }
3236        for flag in &self.ar_flags {
3237            any_flags = true;
3238            cmd.arg(&**flag);
3239        }
3240        Ok((cmd, name, any_flags))
3241    }
3242
3243    fn get_base_archiver(&self) -> Result<(Command, PathBuf), Error> {
3244        if let Some(ref a) = self.archiver {
3245            let archiver = &**a;
3246            return Ok((self.cmd(archiver), archiver.into()));
3247        }
3248
3249        self.get_base_archiver_variant("AR", "ar")
3250    }
3251
3252    /// Get the ranlib that's in use for this configuration.
3253    ///
3254    /// You can use [`Command::get_program`] to get just the path to the command.
3255    ///
3256    /// This method will take into account all configuration such as debug
3257    /// information, optimization level, include directories, defines, etc.
3258    /// Additionally, the compiler binary in use follows the standard
3259    /// conventions for this path, e.g. looking at the explicitly set compiler,
3260    /// environment variables (a number of which are inspected here), and then
3261    /// falling back to the default configuration.
3262    ///
3263    /// # Panics
3264    ///
3265    /// Panics if an error occurred while determining the architecture.
3266    pub fn get_ranlib(&self) -> Command {
3267        match self.try_get_ranlib() {
3268            Ok(tool) => tool,
3269            Err(e) => fail(&e.message),
3270        }
3271    }
3272
3273    /// Get the ranlib that's in use for this configuration.
3274    ///
3275    /// This will return a result instead of panicking;
3276    /// see [`Self::get_ranlib`] for the complete description.
3277    pub fn try_get_ranlib(&self) -> Result<Command, Error> {
3278        let mut cmd = self.get_base_ranlib()?;
3279        if let Some(flags) = self.envflags("RANLIBFLAGS")? {
3280            cmd.args(flags);
3281        }
3282        Ok(cmd)
3283    }
3284
3285    fn get_base_ranlib(&self) -> Result<Command, Error> {
3286        if let Some(ref r) = self.ranlib {
3287            return Ok(self.cmd(&**r));
3288        }
3289
3290        Ok(self.get_base_archiver_variant("RANLIB", "ranlib")?.0)
3291    }
3292
3293    fn get_base_archiver_variant(
3294        &self,
3295        env: &str,
3296        tool: &str,
3297    ) -> Result<(Command, PathBuf), Error> {
3298        let target = self.get_target()?;
3299        let mut name = PathBuf::new();
3300        let tool_opt: Option<Command> = self
3301            .env_tool(env)
3302            .map(|(tool, _wrapper, args)| {
3303                name.clone_from(&tool);
3304                let mut cmd = self.cmd(tool);
3305                cmd.args(args);
3306                cmd
3307            })
3308            .or_else(|| {
3309                if target.os == "emscripten" {
3310                    // Windows use bat files so we have to be a bit more specific
3311                    if cfg!(windows) {
3312                        let mut cmd = self.cmd("cmd");
3313                        name = format!("em{tool}.bat").into();
3314                        cmd.arg("/c").arg(&name);
3315                        Some(cmd)
3316                    } else {
3317                        name = format!("em{tool}").into();
3318                        Some(self.cmd(&name))
3319                    }
3320                } else if target.arch == "wasm32" || target.arch == "wasm64" {
3321                    // Formally speaking one should be able to use this approach,
3322                    // parsing -print-search-dirs output, to cover all clang targets,
3323                    // including Android SDKs and other cross-compilation scenarios...
3324                    // And even extend it to gcc targets by searching for "ar" instead
3325                    // of "llvm-ar"...
3326                    let compiler = self.get_base_compiler().ok()?;
3327                    if compiler.is_like_clang() {
3328                        name = format!("llvm-{tool}").into();
3329                        self.search_programs(&compiler.path, &name, &self.cargo_output)
3330                            .map(|name| self.cmd(name))
3331                    } else {
3332                        None
3333                    }
3334                } else {
3335                    None
3336                }
3337            });
3338
3339        let tool = match tool_opt {
3340            Some(t) => t,
3341            None => {
3342                if target.os == "android" {
3343                    name = format!("llvm-{tool}").into();
3344                    match Command::new(&name).arg("--version").status() {
3345                        Ok(status) if status.success() => (),
3346                        _ => {
3347                            // FIXME: Use parsed target.
3348                            let raw_target = self.get_raw_target()?;
3349                            name = format!("{}-{}", raw_target.replace("armv7", "arm"), tool).into()
3350                        }
3351                    }
3352                    self.cmd(&name)
3353                } else if target.env == "msvc" {
3354                    // NOTE: There isn't really a ranlib on msvc, so arguably we should return
3355                    // `None` somehow here. But in general, callers will already have to be aware
3356                    // of not running ranlib on Windows anyway, so it feels okay to return lib.exe
3357                    // here.
3358
3359                    let compiler = self.get_base_compiler()?;
3360                    let lib = if compiler.family == (ToolFamily::Msvc { clang_cl: true }) {
3361                        self.search_programs(
3362                            &compiler.path,
3363                            Path::new("llvm-lib"),
3364                            &self.cargo_output,
3365                        )
3366                        .or_else(|| {
3367                            // See if there is 'llvm-lib' next to 'clang-cl'
3368                            if let Some(mut cmd) = self.which(&compiler.path, None) {
3369                                cmd.pop();
3370                                cmd.push("llvm-lib");
3371                                self.which(&cmd, None)
3372                            } else {
3373                                None
3374                            }
3375                        })
3376                    } else {
3377                        None
3378                    };
3379
3380                    if let Some(lib) = lib {
3381                        name = lib;
3382                        self.cmd(&name)
3383                    } else {
3384                        name = PathBuf::from("lib.exe");
3385                        let mut cmd = match self.find_msvc_tools_find(&target, "lib.exe") {
3386                            Some(t) => t,
3387                            None => self.cmd("lib.exe"),
3388                        };
3389                        if target.full_arch == "arm64ec" {
3390                            cmd.arg("/machine:arm64ec");
3391                        }
3392                        cmd
3393                    }
3394                } else if target.os == "illumos" {
3395                    // The default 'ar' on illumos uses a non-standard flags,
3396                    // but the OS comes bundled with a GNU-compatible variant.
3397                    //
3398                    // Use the GNU-variant to match other Unix systems.
3399                    name = format!("g{tool}").into();
3400                    self.cmd(&name)
3401                } else if target.os == "vxworks" {
3402                    name = format!("wr-{tool}").into();
3403                    self.cmd(&name)
3404                } else if target.os == "nto" {
3405                    // Ref: https://www.qnx.com/developers/docs/8.0/com.qnx.doc.neutrino.utilities/topic/a/ar.html
3406                    name = match target.full_arch {
3407                        "i586" => format!("ntox86-{tool}").into(),
3408                        "x86" | "aarch64" | "x86_64" => {
3409                            format!("nto{}-{}", target.arch, tool).into()
3410                        }
3411                        _ => {
3412                            return Err(Error::new(
3413                                ErrorKind::InvalidTarget,
3414                                format!("Unknown architecture for Neutrino QNX: {}", target.arch),
3415                            ))
3416                        }
3417                    };
3418                    self.cmd(&name)
3419                } else if self.get_is_cross_compile()? {
3420                    match self.prefix_for_target(&self.get_raw_target()?) {
3421                        Some(prefix) => {
3422                            // GCC uses $target-gcc-ar, whereas binutils uses $target-ar -- try both.
3423                            // Prefer -ar if it exists, as builds of `-gcc-ar` have been observed to be
3424                            // outright broken (such as when targeting freebsd with `--disable-lto`
3425                            // toolchain where the archiver attempts to load the LTO plugin anyway but
3426                            // fails to find one).
3427                            //
3428                            // The same applies to ranlib.
3429                            let chosen = ["", "-gcc"]
3430                                .iter()
3431                                .filter_map(|infix| {
3432                                    let target_p = format!("{prefix}{infix}-{tool}");
3433                                    let status = Command::new(&target_p)
3434                                        .arg("--version")
3435                                        .stdin(Stdio::null())
3436                                        .stdout(Stdio::null())
3437                                        .stderr(Stdio::null())
3438                                        .status()
3439                                        .ok()?;
3440                                    status.success().then_some(target_p)
3441                                })
3442                                .next()
3443                                .unwrap_or_else(|| tool.to_string());
3444                            name = chosen.into();
3445                            self.cmd(&name)
3446                        }
3447                        None => {
3448                            name = tool.into();
3449                            self.cmd(&name)
3450                        }
3451                    }
3452                } else {
3453                    name = tool.into();
3454                    self.cmd(&name)
3455                }
3456            }
3457        };
3458
3459        Ok((tool, name))
3460    }
3461
3462    // FIXME: Use parsed target instead of raw target.
3463    fn prefix_for_target(&self, target: &str) -> Option<Cow<'static, str>> {
3464        // CROSS_COMPILE is of the form: "arm-linux-gnueabi-"
3465        self.getenv("CROSS_COMPILE")
3466            .as_deref()
3467            .map(|s| s.to_string_lossy().trim_end_matches('-').to_owned())
3468            .map(Cow::Owned)
3469            .or_else(|| {
3470                // Put aside RUSTC_LINKER's prefix to be used as second choice, after CROSS_COMPILE
3471                self.getenv("RUSTC_LINKER").and_then(|var| {
3472                    var.to_string_lossy()
3473                        .strip_suffix("-gcc")
3474                        .map(str::to_string)
3475                        .map(Cow::Owned)
3476                })
3477            })
3478            .or_else(|| {
3479                match target {
3480                    // Note: there is no `aarch64-pc-windows-gnu` target, only `-gnullvm`
3481                    "aarch64-pc-windows-gnullvm" => Some("aarch64-w64-mingw32"),
3482                    "aarch64-uwp-windows-gnu" => Some("aarch64-w64-mingw32"),
3483                    "aarch64-unknown-linux-gnu" => Some("aarch64-linux-gnu"),
3484                    "aarch64-unknown-linux-musl" => Some("aarch64-linux-musl"),
3485                    "aarch64-unknown-netbsd" => Some("aarch64--netbsd"),
3486                    "arm-unknown-linux-gnueabi" => Some("arm-linux-gnueabi"),
3487                    "armv4t-unknown-linux-gnueabi" => Some("arm-linux-gnueabi"),
3488                    "armv5te-unknown-linux-gnueabi" => Some("arm-linux-gnueabi"),
3489                    "armv5te-unknown-linux-musleabi" => Some("arm-linux-gnueabi"),
3490                    "arm-unknown-linux-gnueabihf" => Some("arm-linux-gnueabihf"),
3491                    "arm-unknown-linux-musleabi" => Some("arm-linux-musleabi"),
3492                    "arm-unknown-linux-musleabihf" => Some("arm-linux-musleabihf"),
3493                    "arm-unknown-netbsd-eabi" => Some("arm--netbsdelf-eabi"),
3494                    "armv6-unknown-netbsd-eabihf" => Some("armv6--netbsdelf-eabihf"),
3495                    "armv7-unknown-linux-gnueabi" => Some("arm-linux-gnueabi"),
3496                    "armv7-unknown-linux-gnueabihf" => Some("arm-linux-gnueabihf"),
3497                    "armv7-unknown-linux-musleabihf" => Some("arm-linux-musleabihf"),
3498                    "armv7neon-unknown-linux-gnueabihf" => Some("arm-linux-gnueabihf"),
3499                    "armv7neon-unknown-linux-musleabihf" => Some("arm-linux-musleabihf"),
3500                    "thumbv7-unknown-linux-gnueabihf" => Some("arm-linux-gnueabihf"),
3501                    "thumbv7-unknown-linux-musleabihf" => Some("arm-linux-musleabihf"),
3502                    "thumbv7neon-unknown-linux-gnueabihf" => Some("arm-linux-gnueabihf"),
3503                    "thumbv7neon-unknown-linux-musleabihf" => Some("arm-linux-musleabihf"),
3504                    "armv7-unknown-netbsd-eabihf" => Some("armv7--netbsdelf-eabihf"),
3505                    "hexagon-unknown-linux-musl" => Some("hexagon-linux-musl"),
3506                    "i586-unknown-linux-musl" => Some("musl"),
3507                    "i686-pc-windows-gnu" => Some("i686-w64-mingw32"),
3508                    "i686-pc-windows-gnullvm" => Some("i686-w64-mingw32"),
3509                    "i686-uwp-windows-gnu" => Some("i686-w64-mingw32"),
3510                    "i686-unknown-linux-gnu" => self.find_working_gnu_prefix(&[
3511                        "i686-linux-gnu",
3512                        "x86_64-linux-gnu", // transparently support gcc-multilib
3513                    ]), // explicit None if not found, so caller knows to fall back
3514                    "i686-unknown-linux-musl" => Some("musl"),
3515                    "i686-unknown-netbsd" => Some("i486--netbsdelf"),
3516                    "loongarch64-unknown-linux-gnu" => Some("loongarch64-linux-gnu"),
3517                    "m68k-unknown-linux-gnu" => Some("m68k-linux-gnu"),
3518                    "mips-unknown-linux-gnu" => Some("mips-linux-gnu"),
3519                    "mips-unknown-linux-musl" => Some("mips-linux-musl"),
3520                    "mipsel-unknown-linux-gnu" => Some("mipsel-linux-gnu"),
3521                    "mipsel-unknown-linux-musl" => Some("mipsel-linux-musl"),
3522                    "mips64-unknown-linux-gnuabi64" => Some("mips64-linux-gnuabi64"),
3523                    "mips64el-unknown-linux-gnuabi64" => Some("mips64el-linux-gnuabi64"),
3524                    "mipsisa32r6-unknown-linux-gnu" => Some("mipsisa32r6-linux-gnu"),
3525                    "mipsisa32r6el-unknown-linux-gnu" => Some("mipsisa32r6el-linux-gnu"),
3526                    "mipsisa64r6-unknown-linux-gnuabi64" => Some("mipsisa64r6-linux-gnuabi64"),
3527                    "mipsisa64r6el-unknown-linux-gnuabi64" => Some("mipsisa64r6el-linux-gnuabi64"),
3528                    "powerpc-unknown-linux-gnu" => Some("powerpc-linux-gnu"),
3529                    "powerpc-unknown-linux-gnuspe" => Some("powerpc-linux-gnuspe"),
3530                    "powerpc-unknown-netbsd" => Some("powerpc--netbsd"),
3531                    "powerpc64-unknown-linux-gnu" => Some("powerpc64-linux-gnu"),
3532                    "powerpc64le-unknown-linux-gnu" => Some("powerpc64le-linux-gnu"),
3533                    "riscv32i-unknown-none-elf" => self.find_working_gnu_prefix(&[
3534                        "riscv32-unknown-elf",
3535                        "riscv64-unknown-elf",
3536                        "riscv-none-embed",
3537                    ]),
3538                    "riscv32imac-esp-espidf" => Some("riscv32-esp-elf"),
3539                    "riscv32imac-unknown-none-elf" => self.find_working_gnu_prefix(&[
3540                        "riscv32-unknown-elf",
3541                        "riscv64-unknown-elf",
3542                        "riscv-none-embed",
3543                    ]),
3544                    "riscv32imac-unknown-xous-elf" => self.find_working_gnu_prefix(&[
3545                        "riscv32-unknown-elf",
3546                        "riscv64-unknown-elf",
3547                        "riscv-none-embed",
3548                    ]),
3549                    "riscv32imc-esp-espidf" => Some("riscv32-esp-elf"),
3550                    "riscv32imc-unknown-none-elf" => self.find_working_gnu_prefix(&[
3551                        "riscv32-unknown-elf",
3552                        "riscv64-unknown-elf",
3553                        "riscv-none-embed",
3554                    ]),
3555                    "riscv64gc-unknown-none-elf" => self.find_working_gnu_prefix(&[
3556                        "riscv64-unknown-elf",
3557                        "riscv32-unknown-elf",
3558                        "riscv-none-embed",
3559                    ]),
3560                    "riscv64imac-unknown-none-elf" => self.find_working_gnu_prefix(&[
3561                        "riscv64-unknown-elf",
3562                        "riscv32-unknown-elf",
3563                        "riscv-none-embed",
3564                    ]),
3565                    "riscv64gc-unknown-linux-gnu" => Some("riscv64-linux-gnu"),
3566                    "riscv32gc-unknown-linux-gnu" => Some("riscv32-linux-gnu"),
3567                    "riscv64gc-unknown-linux-musl" => Some("riscv64-linux-musl"),
3568                    "riscv32gc-unknown-linux-musl" => Some("riscv32-linux-musl"),
3569                    "riscv64gc-unknown-netbsd" => Some("riscv64--netbsd"),
3570                    "s390x-unknown-linux-gnu" => Some("s390x-linux-gnu"),
3571                    "sparc-unknown-linux-gnu" => Some("sparc-linux-gnu"),
3572                    "sparc64-unknown-linux-gnu" => Some("sparc64-linux-gnu"),
3573                    "sparc64-unknown-netbsd" => Some("sparc64--netbsd"),
3574                    "sparcv9-sun-solaris" => Some("sparcv9-sun-solaris"),
3575                    "armv7a-none-eabi" => Some("arm-none-eabi"),
3576                    "armv7a-none-eabihf" => Some("arm-none-eabi"),
3577                    "armebv7r-none-eabi" => Some("arm-none-eabi"),
3578                    "armebv7r-none-eabihf" => Some("arm-none-eabi"),
3579                    "armv7r-none-eabi" => Some("arm-none-eabi"),
3580                    "armv7r-none-eabihf" => Some("arm-none-eabi"),
3581                    "armv8r-none-eabihf" => Some("arm-none-eabi"),
3582                    "thumbv6m-none-eabi" => Some("arm-none-eabi"),
3583                    "thumbv7em-none-eabi" => Some("arm-none-eabi"),
3584                    "thumbv7em-none-eabihf" => Some("arm-none-eabi"),
3585                    "thumbv7m-none-eabi" => Some("arm-none-eabi"),
3586                    "thumbv8m.base-none-eabi" => Some("arm-none-eabi"),
3587                    "thumbv8m.main-none-eabi" => Some("arm-none-eabi"),
3588                    "thumbv8m.main-none-eabihf" => Some("arm-none-eabi"),
3589                    "x86_64-pc-windows-gnu" => Some("x86_64-w64-mingw32"),
3590                    "x86_64-pc-windows-gnullvm" => Some("x86_64-w64-mingw32"),
3591                    "x86_64-uwp-windows-gnu" => Some("x86_64-w64-mingw32"),
3592                    "x86_64-rumprun-netbsd" => Some("x86_64-rumprun-netbsd"),
3593                    "x86_64-unknown-linux-gnu" => self.find_working_gnu_prefix(&[
3594                        "x86_64-linux-gnu", // rustfmt wrap
3595                    ]), // explicit None if not found, so caller knows to fall back
3596                    "x86_64-unknown-linux-musl" => {
3597                        self.find_working_gnu_prefix(&["x86_64-linux-musl", "musl"])
3598                    }
3599                    "x86_64-unknown-netbsd" => Some("x86_64--netbsd"),
3600                    "xtensa-esp32-espidf"
3601                    | "xtensa-esp32-none-elf"
3602                    | "xtensa-esp32s2-espidf"
3603                    | "xtensa-esp32s2-none-elf"
3604                    | "xtensa-esp32s3-espidf"
3605                    | "xtensa-esp32s3-none-elf" => Some("xtensa-esp-elf"),
3606                    _ => None,
3607                }
3608                .map(Cow::Borrowed)
3609            })
3610    }
3611
3612    /// Some platforms have multiple, compatible, canonical prefixes. Look through
3613    /// each possible prefix for a compiler that exists and return it. The prefixes
3614    /// should be ordered from most-likely to least-likely.
3615    fn find_working_gnu_prefix(&self, prefixes: &[&'static str]) -> Option<&'static str> {
3616        let suffix = if self.cpp { "-g++" } else { "-gcc" };
3617        let extension = std::env::consts::EXE_SUFFIX;
3618
3619        // Loop through PATH entries searching for each toolchain. This ensures that we
3620        // are more likely to discover the toolchain early on, because chances are good
3621        // that the desired toolchain is in one of the higher-priority paths.
3622        self.getenv("PATH")
3623            .as_ref()
3624            .and_then(|path_entries| {
3625                env::split_paths(path_entries).find_map(|path_entry| {
3626                    for prefix in prefixes {
3627                        let target_compiler = format!("{prefix}{suffix}{extension}");
3628                        if path_entry.join(&target_compiler).exists() {
3629                            return Some(prefix);
3630                        }
3631                    }
3632                    None
3633                })
3634            })
3635            .copied()
3636            // If no toolchain was found, provide the first toolchain that was passed in.
3637            // This toolchain has been shown not to exist, however it will appear in the
3638            // error that is shown to the user which should make it easier to search for
3639            // where it should be obtained.
3640            .or_else(|| prefixes.first().copied())
3641    }
3642
3643    fn get_target(&self) -> Result<TargetInfo<'_>, Error> {
3644        match &self.target {
3645            Some(t) if Some(&**t) != self.getenv_unwrap_str("TARGET").ok().as_deref() => {
3646                TargetInfo::from_rustc_target(t)
3647            }
3648            // Fetch target information from environment if not set, or if the
3649            // target was the same as the TARGET environment variable, in
3650            // case the user did `build.target(&env::var("TARGET").unwrap())`.
3651            _ => self
3652                .build_cache
3653                .target_info_parser
3654                .parse_from_cargo_environment_variables(),
3655        }
3656    }
3657
3658    fn get_raw_target(&self) -> Result<Cow<'_, str>, Error> {
3659        match &self.target {
3660            Some(t) => Ok(Cow::Borrowed(t)),
3661            None => self.getenv_unwrap_str("TARGET").map(Cow::Owned),
3662        }
3663    }
3664
3665    fn get_is_cross_compile(&self) -> Result<bool, Error> {
3666        let target = self.get_raw_target()?;
3667        let host: Cow<'_, str> = match &self.host {
3668            Some(h) => Cow::Borrowed(h),
3669            None => Cow::Owned(self.getenv_unwrap_str("HOST")?),
3670        };
3671        Ok(host != target)
3672    }
3673
3674    fn get_opt_level(&self) -> Result<Cow<'_, str>, Error> {
3675        match &self.opt_level {
3676            Some(ol) => Ok(Cow::Borrowed(ol)),
3677            None => self.getenv_unwrap_str("OPT_LEVEL").map(Cow::Owned),
3678        }
3679    }
3680
3681    fn get_debug(&self) -> bool {
3682        self.debug.unwrap_or_else(|| self.getenv_boolean("DEBUG"))
3683    }
3684
3685    fn get_shell_escaped_flags(&self) -> bool {
3686        self.shell_escaped_flags
3687            .unwrap_or_else(|| self.getenv_boolean("CC_SHELL_ESCAPED_FLAGS"))
3688    }
3689
3690    fn get_dwarf_version(&self) -> Option<u32> {
3691        // Tentatively matches the DWARF version defaults as of rustc 1.62.
3692        let target = self.get_target().ok()?;
3693        if matches!(
3694            target.os,
3695            "android" | "dragonfly" | "freebsd" | "netbsd" | "openbsd"
3696        ) || target.vendor == "apple"
3697            || (target.os == "windows" && target.env == "gnu")
3698        {
3699            Some(2)
3700        } else if target.os == "linux" {
3701            Some(4)
3702        } else {
3703            None
3704        }
3705    }
3706
3707    fn get_force_frame_pointer(&self) -> bool {
3708        self.force_frame_pointer.unwrap_or_else(|| self.get_debug())
3709    }
3710
3711    fn get_out_dir(&self) -> Result<Cow<'_, Path>, Error> {
3712        match &self.out_dir {
3713            Some(p) => Ok(Cow::Borrowed(&**p)),
3714            None => self
3715                .getenv("OUT_DIR")
3716                .as_deref()
3717                .map(PathBuf::from)
3718                .map(Cow::Owned)
3719                .ok_or_else(|| {
3720                    Error::new(
3721                        ErrorKind::EnvVarNotFound,
3722                        "Environment variable OUT_DIR not defined.",
3723                    )
3724                }),
3725        }
3726    }
3727
3728    #[allow(clippy::disallowed_methods)]
3729    fn getenv(&self, v: &str) -> Option<Arc<OsStr>> {
3730        // Returns true for environment variables cargo sets for build scripts:
3731        // https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts
3732        //
3733        // This handles more of the vars than we actually use (it tries to check
3734        // complete-ish set), just to avoid needing maintenance if/when new
3735        // calls to `getenv`/`getenv_unwrap` are added.
3736        fn provided_by_cargo(envvar: &str) -> bool {
3737            match envvar {
3738                v if v.starts_with("CARGO") || v.starts_with("RUSTC") => true,
3739                "HOST" | "TARGET" | "RUSTDOC" | "OUT_DIR" | "OPT_LEVEL" | "DEBUG" | "PROFILE"
3740                | "NUM_JOBS" | "RUSTFLAGS" => true,
3741                _ => false,
3742            }
3743        }
3744        if let Some(val) = self.build_cache.env_cache.read().unwrap().get(v).cloned() {
3745            return val;
3746        }
3747        // Excluding `PATH` prevents spurious rebuilds on Windows, see
3748        // <https://github.com/rust-lang/cc-rs/pull/1215> for details.
3749        if self.emit_rerun_if_env_changed && !provided_by_cargo(v) && v != "PATH" {
3750            self.cargo_output
3751                .print_metadata(&format_args!("cargo:rerun-if-env-changed={v}"));
3752        }
3753        let r = self
3754            .env
3755            .iter()
3756            .find(|(k, _)| k.as_ref() == v)
3757            .map(|(_, value)| value.clone())
3758            .or_else(|| env::var_os(v).map(Arc::from));
3759        self.cargo_output.print_metadata(&format_args!(
3760            "{} = {}",
3761            v,
3762            OptionOsStrDisplay(r.as_deref())
3763        ));
3764        self.build_cache
3765            .env_cache
3766            .write()
3767            .unwrap()
3768            .insert(v.into(), r.clone());
3769        r
3770    }
3771
3772    /// get boolean flag that is either true or false
3773    fn getenv_boolean(&self, v: &str) -> bool {
3774        match self.getenv(v) {
3775            Some(s) => &*s != "0" && &*s != "false" && !s.is_empty(),
3776            None => false,
3777        }
3778    }
3779
3780    fn getenv_unwrap(&self, v: &str) -> Result<Arc<OsStr>, Error> {
3781        match self.getenv(v) {
3782            Some(s) => Ok(s),
3783            None => Err(Error::new(
3784                ErrorKind::EnvVarNotFound,
3785                format!("Environment variable {v} not defined."),
3786            )),
3787        }
3788    }
3789
3790    fn getenv_unwrap_str(&self, v: &str) -> Result<String, Error> {
3791        let env = self.getenv_unwrap(v)?;
3792        env.to_str().map(String::from).ok_or_else(|| {
3793            Error::new(
3794                ErrorKind::EnvVarNotFound,
3795                format!("Environment variable {v} is not valid utf-8."),
3796            )
3797        })
3798    }
3799
3800    /// The list of environment variables to check for a given env, in order of priority.
3801    fn target_envs(&self, env: &str) -> Result<[String; 4], Error> {
3802        let target = self.get_raw_target()?;
3803        let kind = if self.get_is_cross_compile()? {
3804            "TARGET"
3805        } else {
3806            "HOST"
3807        };
3808        let target_u = target.replace(['-', '.'], "_");
3809
3810        Ok([
3811            format!("{env}_{target}"),
3812            format!("{env}_{target_u}"),
3813            format!("{kind}_{env}"),
3814            env.to_string(),
3815        ])
3816    }
3817
3818    /// Get a single-valued environment variable with target variants.
3819    fn getenv_with_target_prefixes(&self, env: &str) -> Result<Arc<OsStr>, Error> {
3820        // Take from first environment variable in the environment.
3821        let res = self
3822            .target_envs(env)?
3823            .iter()
3824            .filter_map(|env| self.getenv(env))
3825            .next();
3826
3827        match res {
3828            Some(res) => Ok(res),
3829            None => Err(Error::new(
3830                ErrorKind::EnvVarNotFound,
3831                format!("could not find environment variable {env}"),
3832            )),
3833        }
3834    }
3835
3836    /// Get values from CFLAGS-style environment variable.
3837    fn envflags(&self, env: &str) -> Result<Option<Vec<String>>, Error> {
3838        // Collect from all environment variables, in reverse order as in
3839        // `getenv_with_target_prefixes` precedence (so that `CFLAGS_$TARGET`
3840        // can override flags in `TARGET_CFLAGS`, which overrides those in
3841        // `CFLAGS`).
3842        let mut any_set = false;
3843        let mut res = vec![];
3844        for env in self.target_envs(env)?.iter().rev() {
3845            if let Some(var) = self.getenv(env) {
3846                any_set = true;
3847
3848                let var = var.to_string_lossy();
3849                if self.get_shell_escaped_flags() {
3850                    res.extend(Shlex::new(&var));
3851                } else {
3852                    res.extend(var.split_ascii_whitespace().map(ToString::to_string));
3853                }
3854            }
3855        }
3856
3857        Ok(if any_set { Some(res) } else { None })
3858    }
3859
3860    fn fix_env_for_apple_os(&self, cmd: &mut Command) -> Result<(), Error> {
3861        let target = self.get_target()?;
3862        if cfg!(target_os = "macos") && target.os == "macos" {
3863            // Additionally, `IPHONEOS_DEPLOYMENT_TARGET` must not be set when using the Xcode linker at
3864            // "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/ld",
3865            // although this is apparently ignored when using the linker at "/usr/bin/ld".
3866            cmd.env_remove("IPHONEOS_DEPLOYMENT_TARGET");
3867        }
3868        Ok(())
3869    }
3870
3871    fn apple_sdk_root_inner(&self, sdk: &str) -> Result<Arc<OsStr>, Error> {
3872        // Code copied from rustc's compiler/rustc_codegen_ssa/src/back/link.rs.
3873        if let Some(sdkroot) = self.getenv("SDKROOT") {
3874            let p = Path::new(&sdkroot);
3875            let does_sdkroot_contain = |strings: &[&str]| {
3876                let sdkroot_str = p.to_string_lossy();
3877                strings.iter().any(|s| sdkroot_str.contains(s))
3878            };
3879            match sdk {
3880                // Ignore `SDKROOT` if it's clearly set for the wrong platform.
3881                "appletvos"
3882                    if does_sdkroot_contain(&["TVSimulator.platform", "MacOSX.platform"]) => {}
3883                "appletvsimulator"
3884                    if does_sdkroot_contain(&["TVOS.platform", "MacOSX.platform"]) => {}
3885                "iphoneos"
3886                    if does_sdkroot_contain(&["iPhoneSimulator.platform", "MacOSX.platform"]) => {}
3887                "iphonesimulator"
3888                    if does_sdkroot_contain(&["iPhoneOS.platform", "MacOSX.platform"]) => {}
3889                "macosx10.15"
3890                    if does_sdkroot_contain(&["iPhoneOS.platform", "iPhoneSimulator.platform"]) => {
3891                }
3892                "watchos"
3893                    if does_sdkroot_contain(&["WatchSimulator.platform", "MacOSX.platform"]) => {}
3894                "watchsimulator"
3895                    if does_sdkroot_contain(&["WatchOS.platform", "MacOSX.platform"]) => {}
3896                "xros" if does_sdkroot_contain(&["XRSimulator.platform", "MacOSX.platform"]) => {}
3897                "xrsimulator" if does_sdkroot_contain(&["XROS.platform", "MacOSX.platform"]) => {}
3898                // Ignore `SDKROOT` if it's not a valid path.
3899                _ if !p.is_absolute() || p == Path::new("/") || !p.exists() => {}
3900                _ => return Ok(sdkroot),
3901            }
3902        }
3903
3904        let sdk_path = run_output(
3905            self.cmd("xcrun")
3906                .arg("--show-sdk-path")
3907                .arg("--sdk")
3908                .arg(sdk),
3909            &self.cargo_output,
3910        )?;
3911
3912        let sdk_path = match String::from_utf8(sdk_path) {
3913            Ok(p) => p,
3914            Err(_) => {
3915                return Err(Error::new(
3916                    ErrorKind::IOError,
3917                    "Unable to determine Apple SDK path.",
3918                ));
3919            }
3920        };
3921        Ok(Arc::from(OsStr::new(sdk_path.trim())))
3922    }
3923
3924    fn apple_sdk_root(&self, target: &TargetInfo<'_>) -> Result<Arc<OsStr>, Error> {
3925        let sdk = target.apple_sdk_name();
3926
3927        if let Some(ret) = self
3928            .build_cache
3929            .apple_sdk_root_cache
3930            .read()
3931            .expect("apple_sdk_root_cache lock failed")
3932            .get(sdk)
3933            .cloned()
3934        {
3935            return Ok(ret);
3936        }
3937        let sdk_path = self.apple_sdk_root_inner(sdk)?;
3938        self.build_cache
3939            .apple_sdk_root_cache
3940            .write()
3941            .expect("apple_sdk_root_cache lock failed")
3942            .insert(sdk.into(), sdk_path.clone());
3943        Ok(sdk_path)
3944    }
3945
3946    fn apple_deployment_target(&self, target: &TargetInfo<'_>) -> Arc<str> {
3947        let sdk = target.apple_sdk_name();
3948        if let Some(ret) = self
3949            .build_cache
3950            .apple_versions_cache
3951            .read()
3952            .expect("apple_versions_cache lock failed")
3953            .get(sdk)
3954            .cloned()
3955        {
3956            return ret;
3957        }
3958
3959        let default_deployment_from_sdk = || -> Option<Arc<str>> {
3960            let version = run_output(
3961                self.cmd("xcrun")
3962                    .arg("--show-sdk-version")
3963                    .arg("--sdk")
3964                    .arg(sdk),
3965                &self.cargo_output,
3966            )
3967            .ok()?;
3968
3969            Some(Arc::from(std::str::from_utf8(&version).ok()?.trim()))
3970        };
3971
3972        let deployment_from_env = |name: &str| -> Option<Arc<str>> {
3973            // note that self.env isn't hit in production codepaths, its mostly just for tests which don't
3974            // set the real env
3975            self.env
3976                .iter()
3977                .find(|(k, _)| &**k == OsStr::new(name))
3978                .map(|(_, v)| v)
3979                .cloned()
3980                .or_else(|| self.getenv(name))?
3981                .to_str()
3982                .map(Arc::from)
3983        };
3984
3985        // Determines if the acquired deployment target is too low to support modern C++ on some Apple platform.
3986        //
3987        // A long time ago they used libstdc++, but since macOS 10.9 and iOS 7 libc++ has been the library the SDKs provide to link against.
3988        // If a `cc`` config wants to use C++, we round up to these versions as the baseline.
3989        let maybe_cpp_version_baseline = |deployment_target_ver: Arc<str>| -> Option<Arc<str>> {
3990            if !self.cpp {
3991                return Some(deployment_target_ver);
3992            }
3993
3994            let mut deployment_target = deployment_target_ver
3995                .split('.')
3996                .map(|v| v.parse::<u32>().expect("integer version"));
3997
3998            match target.os {
3999                "macos" => {
4000                    let major = deployment_target.next().unwrap_or(0);
4001                    let minor = deployment_target.next().unwrap_or(0);
4002
4003                    // If below 10.9, we ignore it and let the SDK's target definitions handle it.
4004                    if major == 10 && minor < 9 {
4005                        self.cargo_output.print_warning(&format_args!(
4006                            "macOS deployment target ({deployment_target_ver}) too low, it will be increased"
4007                        ));
4008                        return None;
4009                    }
4010                }
4011                "ios" => {
4012                    let major = deployment_target.next().unwrap_or(0);
4013
4014                    // If below 10.7, we ignore it and let the SDK's target definitions handle it.
4015                    if major < 7 {
4016                        self.cargo_output.print_warning(&format_args!(
4017                            "iOS deployment target ({deployment_target_ver}) too low, it will be increased"
4018                        ));
4019                        return None;
4020                    }
4021                }
4022                // watchOS, tvOS, visionOS, and others are all new enough that libc++ is their baseline.
4023                _ => {}
4024            }
4025
4026            // If the deployment target met or exceeded the C++ baseline
4027            Some(deployment_target_ver)
4028        };
4029
4030        // The hardcoded minimums here are subject to change in a future compiler release,
4031        // and only exist as last resort fallbacks. Don't consider them stable.
4032        // `cc` doesn't use rustc's `--print deployment-target`` because the compiler's defaults
4033        // don't align well with Apple's SDKs and other third-party libraries that require ~generally~ higher
4034        // deployment targets. rustc isn't interested in those by default though so its fine to be different here.
4035        //
4036        // If no explicit target is passed, `cc` defaults to the current Xcode SDK's `DefaultDeploymentTarget` for better
4037        // compatibility. This is also the crate's historical behavior and what has become a relied-on value.
4038        //
4039        // The ordering of env -> XCode SDK -> old rustc defaults is intentional for performance when using
4040        // an explicit target.
4041        let version: Arc<str> = match target.os {
4042            "macos" => deployment_from_env("MACOSX_DEPLOYMENT_TARGET")
4043                .and_then(maybe_cpp_version_baseline)
4044                .or_else(default_deployment_from_sdk)
4045                .unwrap_or_else(|| {
4046                    if target.arch == "aarch64" {
4047                        "11.0".into()
4048                    } else {
4049                        let default: Arc<str> = Arc::from("10.7");
4050                        maybe_cpp_version_baseline(default.clone()).unwrap_or(default)
4051                    }
4052                }),
4053
4054            "ios" => deployment_from_env("IPHONEOS_DEPLOYMENT_TARGET")
4055                .and_then(maybe_cpp_version_baseline)
4056                .or_else(default_deployment_from_sdk)
4057                .unwrap_or_else(|| "7.0".into()),
4058
4059            "watchos" => deployment_from_env("WATCHOS_DEPLOYMENT_TARGET")
4060                .or_else(default_deployment_from_sdk)
4061                .unwrap_or_else(|| "5.0".into()),
4062
4063            "tvos" => deployment_from_env("TVOS_DEPLOYMENT_TARGET")
4064                .or_else(default_deployment_from_sdk)
4065                .unwrap_or_else(|| "9.0".into()),
4066
4067            "visionos" => deployment_from_env("XROS_DEPLOYMENT_TARGET")
4068                .or_else(default_deployment_from_sdk)
4069                .unwrap_or_else(|| "1.0".into()),
4070
4071            os => unreachable!("unknown Apple OS: {}", os),
4072        };
4073
4074        self.build_cache
4075            .apple_versions_cache
4076            .write()
4077            .expect("apple_versions_cache lock failed")
4078            .insert(sdk.into(), version.clone());
4079
4080        version
4081    }
4082
4083    fn wasm_musl_sysroot(&self) -> Result<Arc<OsStr>, Error> {
4084        if let Some(musl_sysroot_path) = self.getenv("WASM_MUSL_SYSROOT") {
4085            Ok(musl_sysroot_path)
4086        } else {
4087            Err(Error::new(
4088                ErrorKind::EnvVarNotFound,
4089                "Environment variable WASM_MUSL_SYSROOT not defined for wasm32. Download sysroot from GitHub & setup environment variable MUSL_SYSROOT targeting the folder.",
4090            ))
4091        }
4092    }
4093
4094    fn wasi_sysroot(&self) -> Result<Arc<OsStr>, Error> {
4095        if let Some(wasi_sysroot_path) = self.getenv("WASI_SYSROOT") {
4096            Ok(wasi_sysroot_path)
4097        } else {
4098            Err(Error::new(
4099                ErrorKind::EnvVarNotFound,
4100                "Environment variable WASI_SYSROOT not defined. Download sysroot from GitHub & setup environment variable WASI_SYSROOT targeting the folder.",
4101            ))
4102        }
4103    }
4104
4105    fn cuda_file_count(&self) -> usize {
4106        self.files
4107            .iter()
4108            .filter(|file| file.extension() == Some(OsStr::new("cu")))
4109            .count()
4110    }
4111
4112    fn which(&self, tool: &Path, path_entries: Option<&OsStr>) -> Option<PathBuf> {
4113        fn check_exe(mut exe: PathBuf) -> Option<PathBuf> {
4114            let exe_ext = std::env::consts::EXE_EXTENSION;
4115            let check =
4116                exe.exists() || (!exe_ext.is_empty() && exe.set_extension(exe_ext) && exe.exists());
4117            check.then_some(exe)
4118        }
4119
4120        // Loop through PATH entries searching for the |tool|.
4121        let find_exe_in_path = |path_entries: &OsStr| -> Option<PathBuf> {
4122            env::split_paths(path_entries).find_map(|path_entry| check_exe(path_entry.join(tool)))
4123        };
4124
4125        // If |tool| is not just one "word," assume it's an actual path...
4126        if tool.components().count() > 1 {
4127            check_exe(PathBuf::from(tool))
4128        } else {
4129            path_entries
4130                .and_then(find_exe_in_path)
4131                .or_else(|| find_exe_in_path(&self.getenv("PATH")?))
4132        }
4133    }
4134
4135    /// search for |prog| on 'programs' path in '|cc| --print-search-dirs' output
4136    fn search_programs(
4137        &self,
4138        cc: &Path,
4139        prog: &Path,
4140        cargo_output: &CargoOutput,
4141    ) -> Option<PathBuf> {
4142        let search_dirs = run_output(
4143            self.cmd(cc).arg("--print-search-dirs"),
4144            // this doesn't concern the compilation so we always want to show warnings.
4145            cargo_output,
4146        )
4147        .ok()?;
4148        // clang driver appears to be forcing UTF-8 output even on Windows,
4149        // hence from_utf8 is assumed to be usable in all cases.
4150        let search_dirs = std::str::from_utf8(&search_dirs).ok()?;
4151        for dirs in search_dirs.split(['\r', '\n']) {
4152            if let Some(path) = dirs.strip_prefix("programs: =") {
4153                return self.which(prog, Some(OsStr::new(path)));
4154            }
4155        }
4156        None
4157    }
4158
4159    fn find_msvc_tools_find(&self, target: &TargetInfo<'_>, tool: &str) -> Option<Command> {
4160        self.find_msvc_tools_find_tool(target, tool)
4161            .map(|c| c.to_command())
4162    }
4163
4164    fn find_msvc_tools_find_tool(&self, target: &TargetInfo<'_>, tool: &str) -> Option<Tool> {
4165        struct BuildEnvGetter<'s>(&'s Build);
4166
4167        impl ::find_msvc_tools::EnvGetter for BuildEnvGetter<'_> {
4168            fn get_env(&self, name: &str) -> Option<::find_msvc_tools::Env> {
4169                self.0.getenv(name).map(::find_msvc_tools::Env::Arced)
4170            }
4171        }
4172
4173        if target.env != "msvc" {
4174            return None;
4175        }
4176
4177        ::find_msvc_tools::find_tool_with_env(target.full_arch, tool, &BuildEnvGetter(self))
4178            .map(Tool::from_find_msvc_tools)
4179    }
4180
4181    /// Compiling for WASI targets typically uses the [wasi-sdk] project and
4182    /// installations of wasi-sdk are typically indicated with the
4183    /// `WASI_SDK_PATH` environment variable. Check to see if that environment
4184    /// variable exists, and check to see if an appropriate compiler is located
4185    /// there. If that all passes then use that compiler by default, but
4186    /// otherwise fall back to whatever the clang default is since gcc doesn't
4187    /// have support for compiling to wasm.
4188    ///
4189    /// [wasi-sdk]: https://github.com/WebAssembly/wasi-sdk
4190    fn autodetect_wasi_compiler(&self, raw_target: &str, clang: &str) -> PathBuf {
4191        if let Some(path) = self.getenv("WASI_SDK_PATH") {
4192            let target_clang = Path::new(&path)
4193                .join("bin")
4194                .join(format!("{raw_target}-clang"));
4195            if let Some(path) = self.which(&target_clang, None) {
4196                return path;
4197            }
4198        }
4199
4200        clang.into()
4201    }
4202}
4203
4204impl Default for Build {
4205    fn default() -> Build {
4206        Build::new()
4207    }
4208}
4209
4210fn fail(s: &str) -> ! {
4211    eprintln!("\n\nerror occurred in cc-rs: {s}\n\n");
4212    std::process::exit(1);
4213}
4214
4215// Use by default minimum available API level
4216// See note about naming here
4217// https://android.googlesource.com/platform/ndk/+/refs/heads/ndk-release-r21/docs/BuildSystemMaintainers.md#Clang
4218static NEW_STANDALONE_ANDROID_COMPILERS: [&str; 4] = [
4219    "aarch64-linux-android21-clang",
4220    "armv7a-linux-androideabi16-clang",
4221    "i686-linux-android16-clang",
4222    "x86_64-linux-android21-clang",
4223];
4224
4225// New "standalone" C/C++ cross-compiler executables from recent Android NDK
4226// are just shell scripts that call main clang binary (from Android NDK) with
4227// proper `--target` argument.
4228//
4229// For example, armv7a-linux-androideabi16-clang passes
4230// `--target=armv7a-linux-androideabi16` to clang.
4231// So to construct proper command line check if
4232// `--target` argument would be passed or not to clang
4233fn android_clang_compiler_uses_target_arg_internally(clang_path: &Path) -> bool {
4234    if let Some(filename) = clang_path.file_name() {
4235        if let Some(filename_str) = filename.to_str() {
4236            if let Some(idx) = filename_str.rfind('-') {
4237                return filename_str.split_at(idx).0.contains("android");
4238            }
4239        }
4240    }
4241    false
4242}
4243
4244// FIXME: Use parsed target.
4245fn autodetect_android_compiler(raw_target: &str, gnu: &str, clang: &str) -> PathBuf {
4246    let new_clang_key = match raw_target {
4247        "aarch64-linux-android" => Some("aarch64"),
4248        "armv7-linux-androideabi" => Some("armv7a"),
4249        "i686-linux-android" => Some("i686"),
4250        "x86_64-linux-android" => Some("x86_64"),
4251        _ => None,
4252    };
4253
4254    let new_clang = new_clang_key
4255        .map(|key| {
4256            NEW_STANDALONE_ANDROID_COMPILERS
4257                .iter()
4258                .find(|x| x.starts_with(key))
4259        })
4260        .unwrap_or(None);
4261
4262    if let Some(new_clang) = new_clang {
4263        if Command::new(new_clang).output().is_ok() {
4264            return (*new_clang).into();
4265        }
4266    }
4267
4268    let target = raw_target
4269        .replace("armv7neon", "arm")
4270        .replace("armv7", "arm")
4271        .replace("thumbv7neon", "arm")
4272        .replace("thumbv7", "arm");
4273    let gnu_compiler = format!("{target}-{gnu}");
4274    let clang_compiler = format!("{target}-{clang}");
4275
4276    // On Windows, the Android clang compiler is provided as a `.cmd` file instead
4277    // of a `.exe` file. `std::process::Command` won't run `.cmd` files unless the
4278    // `.cmd` is explicitly appended to the command name, so we do that here.
4279    let clang_compiler_cmd = format!("{target}-{clang}.cmd");
4280
4281    // Check if gnu compiler is present
4282    // if not, use clang
4283    if Command::new(&gnu_compiler).output().is_ok() {
4284        gnu_compiler
4285    } else if cfg!(windows) && Command::new(&clang_compiler_cmd).output().is_ok() {
4286        clang_compiler_cmd
4287    } else {
4288        clang_compiler
4289    }
4290    .into()
4291}
4292
4293// Rust and clang/cc don't agree on how to name the target.
4294fn map_darwin_target_from_rust_to_compiler_architecture<'a>(target: &TargetInfo<'a>) -> &'a str {
4295    match target.full_arch {
4296        "aarch64" => "arm64",
4297        "arm64_32" => "arm64_32",
4298        "arm64e" => "arm64e",
4299        "armv7k" => "armv7k",
4300        "armv7s" => "armv7s",
4301        "i386" => "i386",
4302        "i686" => "i386",
4303        "powerpc" => "ppc",
4304        "powerpc64" => "ppc64",
4305        "x86_64" => "x86_64",
4306        "x86_64h" => "x86_64h",
4307        arch => arch,
4308    }
4309}
4310
4311fn is_arm(target: &TargetInfo<'_>) -> bool {
4312    matches!(target.arch, "aarch64" | "arm64ec" | "arm")
4313}
4314
4315#[derive(Clone, Copy, PartialEq)]
4316enum AsmFileExt {
4317    /// `.asm` files. On MSVC targets, we assume these should be passed to MASM
4318    /// (`ml{,64}.exe`).
4319    DotAsm,
4320    /// `.s` or `.S` files, which do not have the special handling on MSVC targets.
4321    DotS,
4322}
4323
4324impl AsmFileExt {
4325    fn from_path(file: &Path) -> Option<Self> {
4326        if let Some(ext) = file.extension() {
4327            if let Some(ext) = ext.to_str() {
4328                let ext = ext.to_lowercase();
4329                match &*ext {
4330                    "asm" => return Some(AsmFileExt::DotAsm),
4331                    "s" => return Some(AsmFileExt::DotS),
4332                    _ => return None,
4333                }
4334            }
4335        }
4336        None
4337    }
4338}
4339
4340/// Returns true if `cc` has been disabled by `CC_FORCE_DISABLE`.
4341fn is_disabled() -> bool {
4342    static CACHE: AtomicU8 = AtomicU8::new(0);
4343
4344    let val = CACHE.load(Relaxed);
4345    // We manually cache the environment var, since we need it in some places
4346    // where we don't have access to a `Build` instance.
4347    #[allow(clippy::disallowed_methods)]
4348    fn compute_is_disabled() -> bool {
4349        match std::env::var_os("CC_FORCE_DISABLE") {
4350            // Not set? Not disabled.
4351            None => false,
4352            // Respect `CC_FORCE_DISABLE=0` and some simple synonyms, otherwise
4353            // we're disabled. This intentionally includes `CC_FORCE_DISABLE=""`
4354            Some(v) => &*v != "0" && &*v != "false" && &*v != "no",
4355        }
4356    }
4357    match val {
4358        2 => true,
4359        1 => false,
4360        0 => {
4361            let truth = compute_is_disabled();
4362            let encoded_truth = if truth { 2u8 } else { 1 };
4363            // Use compare_exchange to avoid race condition
4364            let _ = CACHE.compare_exchange(0, encoded_truth, Relaxed, Relaxed);
4365            truth
4366        }
4367        _ => unreachable!(),
4368    }
4369}
4370
4371/// Automates the `if is_disabled() { return error }` check and ensures
4372/// we produce a consistent error message for it.
4373fn check_disabled() -> Result<(), Error> {
4374    if is_disabled() {
4375        return Err(Error::new(
4376            ErrorKind::Disabled,
4377            "the `cc` crate's functionality has been disabled by the `CC_FORCE_DISABLE` environment variable."
4378        ));
4379    }
4380    Ok(())
4381}
4382
4383#[cfg(test)]
4384mod tests {
4385    use super::*;
4386
4387    #[test]
4388    fn test_android_clang_compiler_uses_target_arg_internally() {
4389        for version in 16..21 {
4390            assert!(android_clang_compiler_uses_target_arg_internally(
4391                &PathBuf::from(format!("armv7a-linux-androideabi{}-clang", version))
4392            ));
4393            assert!(android_clang_compiler_uses_target_arg_internally(
4394                &PathBuf::from(format!("armv7a-linux-androideabi{}-clang++", version))
4395            ));
4396        }
4397        assert!(!android_clang_compiler_uses_target_arg_internally(
4398            &PathBuf::from("clang-i686-linux-android")
4399        ));
4400        assert!(!android_clang_compiler_uses_target_arg_internally(
4401            &PathBuf::from("clang")
4402        ));
4403        assert!(!android_clang_compiler_uses_target_arg_internally(
4404            &PathBuf::from("clang++")
4405        ));
4406    }
4407}