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