cc/
lib.rs

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