Skip to main content

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