Skip to content

Build script DRY #494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kornelski wants to merge 2 commits into
base: master
Choose a base branch
from
+56 −96
Open

Build script DRY #494

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b7b97e
DRY Apple SDK setting
kornelski Apr 18, 2026
d417da1
Build help/cleanups
kornelski Apr 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions boring-sys/build/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ pub(crate) struct Env {
pub(crate) debug: Option<OsString>,
pub(crate) opt_level: Option<OsString>,
pub(crate) android_ndk_home: Option<PathBuf>,
pub(crate) cmake_toolchain_file: Option<PathBuf>,
pub(crate) cmake_toolchain_file_is_set: bool,
pub(crate) cpp_runtime_lib: Option<OsString>,
/// C compiler (ignored if using FIPS)
pub(crate) cc: Option<OsString>,
Expand Down Expand Up @@ -160,7 +160,7 @@ impl Env {

// The passed name is the non-fips version of the environment variable,
// to help look for them in the repository.
assert!(name.starts_with(BORING_BSSL_PREFIX));
debug_assert!(name.starts_with(BORING_BSSL_PREFIX));

let non_fips = target_var(name);
if is_fips_like {
Expand All @@ -181,13 +181,15 @@ impl Env {
source_path: boringssl_var("BORING_BSSL_SOURCE_PATH").map(PathBuf::from), // gets BORING_BSSL_FIPS_SOURCE_PATH if fips is enabled
assume_patched: boringssl_var("BORING_BSSL_ASSUME_PATCHED") // gets BORING_BSSL_FIPS_ASSUME_PATCHED if fips is enabled
.is_some_and(|v| !v.is_empty()),
// only used when cross-compiling
sysroot: boringssl_var("BORING_BSSL_SYSROOT").map(PathBuf::from), // gets BORING_BSSL_FIPS_SYSROOT if fips is enabled
// only used when cross-compiling
compiler_external_toolchain: boringssl_var("BORING_BSSL_COMPILER_EXTERNAL_TOOLCHAIN") // gets BORING_BSSL_FIPS_COMPILER_EXTERNAL_TOOLCHAIN if fips is enabled
.map(PathBuf::from),
debug: target_var("DEBUG"),
opt_level: target_var("OPT_LEVEL"),
android_ndk_home: target_var("ANDROID_NDK_HOME").map(Into::into),
cmake_toolchain_file: target_var("CMAKE_TOOLCHAIN_FILE").map(Into::into),
cmake_toolchain_file_is_set: var("CMAKE_TOOLCHAIN_FILE").is_some(),
cpp_runtime_lib: target_var("BORING_BSSL_RUST_CPPLIB"),
// matches the `cc` crate
cc: target_only_var("CC"),
Expand Down
144 changes: 51 additions & 93 deletions boring-sys/build/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,13 @@ fn cmake_params_android(config: &Config) -> &'static [(&'static str, &'static st
}

const CMAKE_PARAMS_APPLE: &[(&str, &[(&str, &str)])] = &[
// iOS
(
"aarch64-apple-ios",
&[
("CMAKE_OSX_ARCHITECTURES", "arm64"),
("CMAKE_OSX_SYSROOT", "iphoneos"),
("CMAKE_MACOSX_BUNDLE", "OFF"),
("CMAKE_ASM_FLAGS", "-fembed-bitcode"),
],
),
(
Expand All @@ -59,6 +59,7 @@ const CMAKE_PARAMS_APPLE: &[(&str, &[(&str, &str)])] = &[
("CMAKE_OSX_ARCHITECTURES", "arm64"),
("CMAKE_OSX_SYSROOT", "iphonesimulator"),
("CMAKE_MACOSX_BUNDLE", "OFF"),
("CMAKE_ASM_FLAGS", "-fembed-bitcode"),
],
),
(
Expand All @@ -67,9 +68,12 @@ const CMAKE_PARAMS_APPLE: &[(&str, &[(&str, &str)])] = &[
("CMAKE_OSX_ARCHITECTURES", "x86_64"),
("CMAKE_OSX_SYSROOT", "iphonesimulator"),
("CMAKE_MACOSX_BUNDLE", "OFF"),
(
"CMAKE_ASM_FLAGS",
"-fembed-bitcode -target x86_64-apple-ios-simulator",
),
],
),
// macOS
(
"aarch64-apple-darwin",
&[
Expand All @@ -87,25 +91,16 @@ const CMAKE_PARAMS_APPLE: &[(&str, &[(&str, &str)])] = &[
];

fn cmake_params_apple(config: &Config) -> &'static [(&'static str, &'static str)] {
for (next_target, params) in CMAKE_PARAMS_APPLE {
if *next_target == config.target {
return params;
}
}
&[]
CMAKE_PARAMS_APPLE
.iter()
.find_map(|&(target, params)| (target == config.target).then_some(params))
.unwrap_or_default()
}

fn get_apple_sdk_name(config: &Config) -> &'static str {
for (name, value) in cmake_params_apple(config) {
if *name == "CMAKE_OSX_SYSROOT" {
return value;
}
}

panic!(
"cannot find SDK for {} in CMAKE_PARAMS_APPLE",
config.target
);
fn get_apple_sdk_name(config: &Config) -> Option<&'static str> {
cmake_params_apple(config)
.iter()
.find_map(|&(name, value)| (name == "CMAKE_OSX_SYSROOT").then_some(value))
}

/// Returns an absolute path to the BoringSSL source.
Expand Down Expand Up @@ -209,7 +204,8 @@ fn get_boringssl_cmake_config(config: &Config) -> cmake::Config {
let src_path = get_boringssl_source_path(config);
let mut boringssl_cmake = cmake::Config::new(src_path);

if config.env.cmake_toolchain_file.is_some() {
if config.env.cmake_toolchain_file_is_set {
println!("cargo::warning=CMAKE_TOOLCHAIN_FILE var set; won't customize cmake vars");
return boringssl_cmake;
}

Expand All @@ -218,14 +214,18 @@ fn get_boringssl_cmake_config(config: &Config) -> cmake::Config {
// This is required now because newest BoringSSL requires CMake 3.22 which
// uses the new logic with CMAKE_MSVC_RUNTIME_LIBRARY introduced in CMake 3.15.
// https://github.com/rust-lang/cmake-rs/pull/30#issuecomment-2969758499
if config.target_features.iter().any(|f| f == "crt-static") {
boringssl_cmake.define("CMAKE_MSVC_RUNTIME_LIBRARY", "MultiThreaded");
let rt = if config.target_features.iter().any(|f| f == "crt-static") {
"MultiThreaded"
} else {
boringssl_cmake.define("CMAKE_MSVC_RUNTIME_LIBRARY", "MultiThreadedDLL");
}
"MultiThreadedDLL"
};
boringssl_cmake.define("CMAKE_MSVC_RUNTIME_LIBRARY", rt);
}

if config.host == config.target {
if config.env.compiler_external_toolchain.is_some() {
println!("cargo::warning=COMPILER_EXTERNAL_TOOLCHAIN won't be used");
}
return boringssl_cmake;
}

Expand Down Expand Up @@ -258,7 +258,7 @@ fn get_boringssl_cmake_config(config: &Config) -> cmake::Config {
}

// Add platform-specific parameters for cross-compilation.
match &*config.target_os {
let toolchain_file = match &*config.target_os {
"android" => {
// We need ANDROID_NDK_HOME to be set properly.
let android_ndk_home = config
Expand All @@ -271,89 +271,44 @@ fn get_boringssl_cmake_config(config: &Config) -> cmake::Config {
boringssl_cmake.define(name, value);
}
let toolchain_file = android_ndk_home.join("build/cmake/android.toolchain.cmake");
let toolchain_file = toolchain_file.to_str().unwrap();
eprintln!("android toolchain={toolchain_file}");
boringssl_cmake.define("CMAKE_TOOLCHAIN_FILE", toolchain_file);

// 21 is the minimum level tested. You can give higher value.
boringssl_cmake.define("CMAKE_SYSTEM_VERSION", "21");
boringssl_cmake.define("CMAKE_ANDROID_STL_TYPE", "c++_shared");
Some(toolchain_file)
}

"macos" => {
os @ ("macos" | "ios") => {
for (name, value) in cmake_params_apple(config) {
eprintln!("macos arch={} add {}={}", config.target_arch, name, value);
eprintln!("{os} arch={} add {}={}", config.target_arch, name, value);
boringssl_cmake.define(name, value);
}
None
}

"ios" => {
for (name, value) in cmake_params_apple(config) {
eprintln!("ios arch={} add {}={}", config.target_arch, name, value);
boringssl_cmake.define(name, value);
}

// Bitcode is always on.
let bitcode_cflag = "-fembed-bitcode";

// Hack for Xcode 10.1.
let target_cflag = if config.target_arch == "x86_64" {
"-target x86_64-apple-ios-simulator"
} else {
""
};

let cflag = format!("{bitcode_cflag} {target_cflag}");
boringssl_cmake.define("CMAKE_ASM_FLAGS", &cflag);
boringssl_cmake.cflag(&cflag);
}

"windows" if config.host.contains("windows") => {
// BoringSSL's CMakeLists.txt isn't set up for cross-compiling using Visual Studio.
// Disable assembly support so that it at least builds.
boringssl_cmake.define("OPENSSL_NO_ASM", "YES");
None
}

"linux" => match &*config.target_arch {
"x86" => {
boringssl_cmake.define(
"CMAKE_TOOLCHAIN_FILE",
// `src_path` can be a path relative to the manifest dir, but
// cmake hates that.
config
.manifest_dir
.join(src_path)
.join("util/32-bit-toolchain.cmake")
.as_os_str(),
);
}
"aarch64" => {
boringssl_cmake.define(
"CMAKE_TOOLCHAIN_FILE",
config
.manifest_dir
.join("cmake/aarch64-linux.cmake")
.as_os_str(),
);
}
"arm" => {
boringssl_cmake.define(
"CMAKE_TOOLCHAIN_FILE",
config
.manifest_dir
.join("cmake/armv7-linux.cmake")
.as_os_str(),
);
}
_ => {
println!(
"cargo:warning=no toolchain file configured by boring-sys for {}",
config.target
);
}
"x86" => Some(
config
.manifest_dir
.join(src_path)
.join("util/32-bit-toolchain.cmake"),
),
"aarch64" => Some(config.manifest_dir.join("cmake/aarch64-linux.cmake")),
"arm" => Some(config.manifest_dir.join("cmake/armv7-linux.cmake")),
_ => None,
},
_ => None,
};

_ => {}
if let Some(tf) = toolchain_file.filter(|tf| tf.exists()) {
eprintln!("{} toolchain={}", config.target_os, tf.display());
boringssl_cmake.define("CMAKE_TOOLCHAIN_FILE", tf);
} else {
println!("cargo::warning=no toolchain file set for {}", config.target);
}

boringssl_cmake
Expand Down Expand Up @@ -394,8 +349,11 @@ fn get_extra_clang_args_for_bindgen(config: &Config) -> Vec<String> {
"ios" | "macos" => {
// When cross-compiling for Apple targets, tell bindgen to use SDK sysroot,
// and *don't* use system headers of the host macOS.
let sdk = get_apple_sdk_name(config);
match run_command(Command::new("xcrun").args(["--show-sdk-path", "--sdk", sdk])) {
match get_apple_sdk_name(config)
.ok_or_else(|| io::Error::other(format!("can't find SDK for {}", config.target)))
.and_then(|sdk| {
run_command(Command::new("xcrun").args(["--show-sdk-path", "--sdk", sdk]))
}) {
Ok(output) => {
let sysroot = std::str::from_utf8(&output.stdout).expect("xcrun output");
params.push("-isysroot".to_string());
Expand Down
Loading