Skip to content
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

Jump to bottom

Add extra symlinks for clang-cl compatibility with /winsdkdir and /vctoolsdir #47

Merged
merged 5 commits into from
May 16, 2022
Merged

Add extra symlinks for clang-cl compatibility with /winsdkdir and /vctoolsdir #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
332921a
add symlinks for the sdk version in sdk/lib and sdk/include
Qyriad May 13, 2022
5909ecf
symlink sdk/Include -> sdk/include and sdk/Lib -> sdk/lib
Qyriad May 13, 2022
6d1873b
Rustfmt
Jake-Shadle May 16, 2022
15be0e2
Add test with newly supported flags
Jake-Shadle May 16, 2022
c4a11a1
Skip new test config on CI
Jake-Shadle May 16, 2022
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
55 changes: 55 additions & 0 deletions src/splat.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
use crate::{Arch, Ctx, Error, Path, PathBuf, PayloadKind, Variant};
use anyhow::Context as _;
use camino::Utf8Path;
use rayon::prelude::*;
use std::collections::BTreeMap;

Expand Down Expand Up @@ -79,6 +80,17 @@ pub(crate) fn prep_splat(
})
}

/// Get the Windows SDK version from the .msi filename.
fn find_sdk_version(sdk_filename: &Utf8Path) -> String {
sdk_filename
.as_str()
.chars()
.skip_while(|ch| ch != &'_')
.skip(1)
.take_while(|ch| ch != &'_')
.collect()
}

pub(crate) fn splat(
config: &SplatConfig,
roots: &SplatRoots,
Expand Down Expand Up @@ -492,6 +504,49 @@ pub(crate) fn splat(
})
.collect_into_vec(&mut results);

match item.payload.kind {
PayloadKind::SdkLibs => {
// Symlink sdk/lib/{sdkversion} -> sdk/lib, regardless of filesystem case sensitivity.
let sdk_version = find_sdk_version(&item.payload.filename);
let mut versioned_linkname = roots.sdk.clone();
versioned_linkname.push("lib");
versioned_linkname.push(sdk_version);
symlink(".", &versioned_linkname)?;
Copy link
Contributor

@messense messense May 16, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just tried this in xwin 0.2.2, looks like this will fail when more than one architectures are specified?

Error: failed to splat Win10SDK_10.0.20348_libs_aarch64.msi

Caused by:
    0: unable to symlink from /home/runner/.cache/cargo-xwin/xwin/sdk/lib/10.0.20348 to .
    1: File exists (os error 17)

https://github.com/messense/cargo-xwin/runs/6448797813?check_suite_focus=true

Works fine when only one architecture is specified.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoopsie! Thank you for fixing that 😅


// https://github.com/llvm/llvm-project/blob/release/14.x/clang/lib/Driver/ToolChains/MSVC.cpp#L1102
if config.enable_symlinks {
let mut title_case = roots.sdk.clone();
title_case.push("Lib");
if !title_case.exists() {
symlink("lib", &title_case)?;
}
}
}
PayloadKind::SdkHeaders => {
// Symlink sdk/include/{sdkversion} -> sdk/include, regardless of filesystem case sensitivity.
let sdk_version = find_sdk_version(&item.payload.filename);
let mut versioned_linkname = roots.sdk.clone();
versioned_linkname.push("include");
versioned_linkname.push(sdk_version);

// Desktop and Store variants both have an include dir,
// but we only need to create this symlink once.
if !versioned_linkname.exists() {
symlink(".", &versioned_linkname)?;
}

// https://github.com/llvm/llvm-project/blob/release/14.x/clang/lib/Driver/ToolChains/MSVC.cpp#L1340-L1346
if config.enable_symlinks {
let mut title_case = roots.sdk.clone();
title_case.push("Include");
if !title_case.exists() {
symlink("include", &title_case)?;
}
}
}
_ => (),
};

item.progress.finish_with_message("📦 splatted");

let headers = results.into_iter().collect::<Result<Vec<_>, _>>()?;
Expand Down
41 changes: 41 additions & 0 deletions tests/compiles.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ fn verify_compiles() {
)
.unwrap();

if xwin::Path::new("tests/xwin-test/target").exists() {
std::fs::remove_dir_all("tests/xwin-test/target").expect("failed to remove target dir");
}

let mut cmd = std::process::Command::new("cargo");
cmd.args(&[
"build",
Expand All @@ -76,4 +80,41 @@ fn verify_compiles() {
cmd.envs(cc_env);

assert!(cmd.status().unwrap().success());

// Ignore the /vctoolsdir /winsdkdir test below on CI since it fails, I'm assuming
// due to the clang version in GHA being outdated, but don't have the will to
// look into it now
if std::env::var("CI").is_ok() {
return;
}

std::fs::remove_dir_all("tests/xwin-test/target").expect("failed to remove target dir");

let mut cmd = std::process::Command::new("cargo");
cmd.args(&[
"build",
"--target",
"x86_64-pc-windows-msvc",
"--manifest-path",
"tests/xwin-test/Cargo.toml",
]);

let includes = format!(
"-Wno-unused-command-line-argument -fuse-ld=lld-link /vctoolsdir {0}/crt /winsdkdir {0}/sdk",
output_dir
);
let libs = format!("-C linker=lld-link -Lnative={0}/crt/lib/x86_64 -Lnative={0}/sdk/lib/um/x86_64 -Lnative={0}/sdk/lib/ucrt/x86_64", output_dir);

let cc_env = [
("CC_x86_64_pc_windows_msvc", "clang-cl"),
("CXX_x86_64_pc_windows_msvc", "clang-cl"),
("AR_x86_64_pc_windows_msvc", "llvm-lib"),
("CFLAGS_x86_64_pc_windows_msvc", &includes),
("CXXFLAGS_x86_64_pc_windows_msvc", &includes),
("RUSTFLAGS", &libs),
];

cmd.envs(cc_env);

assert!(cmd.status().unwrap().success());
}
4 changes: 4 additions & 0 deletions tests/expected.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,9 @@ crt/lib/x86_64/vccorlib.lib @ 88dff09680406ce8
crt/lib/x86_64/vcomp.lib @ 290001f1cf8658dc
crt/lib/x86_64/vcruntime.lib @ 13fe902a335d605f
crt/lib/x86_64/wsetargv.obj @ 887c6f64baebe131
sdk/Include => include
sdk/Lib => lib
sdk/include/10.0.20348 => .
sdk/include/cppwinrt/LICENSE.txt @ d824dd57cab041e7
sdk/include/cppwinrt/license.txt => LICENSE.txt
sdk/include/cppwinrt/winrt/Windows.AI.MachineLearning.h => windows.ai.machinelearning.h
Expand Down Expand Up @@ -7249,6 +7252,7 @@ sdk/include/winrt/wrl/module.h @ d0a209cfdd29d5c9
sdk/include/winrt/wrl/wrappers/corewrappers.h @ aa2b216bc669030e
sdk/include/winrt/wrl.h @ 7f6c2dca3e863bbc
sdk/include/winrt/wsdevlicensing.h => Wsdevlicensing.h
sdk/lib/10.0.20348 => .
sdk/lib/ucrt/x86_64/libucrt.lib @ bd614cab0015a4e
sdk/lib/ucrt/x86_64/ucrt.lib @ 8140b809879bb580
sdk/lib/um/x86_64/ACLUI.lib => AclUI.Lib
Expand Down