Skip to content

[clang][Driver][Darwin] Optionally use xcselect to find macOS SDK #119670

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
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

[clang][Driver][Darwin] Optionally use xcselect to find macOS SDK #119670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9db768e
[clang][Driver][Darwin] Optionally use xcselect to find macOS SDK
carlocab Dec 9, 2024
8b5afe0
Gate all `xcselect` checks behind `CLANG_USE_XCSELECT`
carlocab Dec 12, 2024
27a5e19
Avoid `if` conditions with multiple statements
carlocab Dec 12, 2024
7e9bbf7
Add xcselect test
carlocab Dec 13, 2024
dc195bd
Mark failing tests with CLANG_USE_XCSELECT as XFAIL
carlocab Dec 13, 2024
8c0ea7f
Use xcselect only for `-macosx` triples
carlocab Dec 13, 2024
c505838
Fix test failures with `CLANG_USE_XCSELECT`
carlocab Dec 13, 2024
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
38 changes: 38 additions & 0 deletions clang/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,44 @@ if(GCC_INSTALL_PREFIX AND NOT USE_DEPRECATED_GCC_INSTALL_PREFIX)
"See https://github.com/llvm/llvm-project/pull/77537 for detail.")
endif()

cmake_dependent_option(CLANG_USE_XCSELECT "Use libxcselect to find the macOS SDK." OFF "APPLE" OFF)

if(CLANG_USE_XCSELECT)
if(DEFAULT_SYSROOT)
message(FATAL_ERROR "Setting DEFAULT_SYSROOT is incompatible with CLANG_USE_XCSELECT.")
endif()

check_include_file(xcselect.h CLANG_HAVE_XCSELECT_H)
if(NOT CLANG_HAVE_XCSELECT_H)
message(FATAL_ERROR "CLANG_USE_XCSELECT is enabled but xcselect.h was not found.")
endif()

include(CheckSymbolExists)
list(APPEND CMAKE_REQUIRED_LIBRARIES xcselect)
check_symbol_exists(xcselect_host_sdk_path xcselect.h CLANG_HAVE_XCSELECT_HOST_SDK_PATH)
list(REMOVE_ITEM CMAKE_REQUIRED_LIBRARIES xcselect)

if(NOT CLANG_HAVE_XCSELECT_HOST_SDK_PATH)
message(FATAL_ERROR "CLANG_USE_XCSELECT is enabled but either libxcselect is not available "
"or it is missing xcselect_host_sdk_path.")
endif()

set(XCSELECT_VALID_POLICIES LATEST MATCHING_ONLY MATCHING_PREFERRED)
set(CLANG_XCSELECT_HOST_SDK_POLICY "LATEST" CACHE STRING
"Policy to use for xcselect. One of: ${XCSELECT_VALID_POLICIES}")
set_property(CACHE CLANG_XCSELECT_HOST_SDK_POLICY PROPERTY STRINGS ${XCSELECT_VALID_POLICIES})
string(TOUPPER ${CLANG_XCSELECT_HOST_SDK_POLICY} CLANG_XCSELECT_HOST_SDK_POLICY)
list(JOIN XCSELECT_VALID_POLICIES "|" XCSELECT_POLICY_REGEX)

if(NOT CLANG_XCSELECT_HOST_SDK_POLICY MATCHES "^XCSELECT_HOST_SDK_POLICY_(${XCSELECT_POLICY_REGEX})$")
if(NOT CLANG_XCSELECT_HOST_SDK_POLICY IN_LIST XCSELECT_VALID_POLICIES)
message(FATAL_ERROR
"CLANG_XCSELECT_HOST_SDK_POLICY (${CLANG_XCSELECT_HOST_SDK_POLICY}) must be one of: ${XCSELECT_VALID_POLICIES}")
endif()
set(CLANG_XCSELECT_HOST_SDK_POLICY "XCSELECT_HOST_SDK_POLICY_${CLANG_XCSELECT_HOST_SDK_POLICY}")
endif()
endif()

set(ENABLE_LINKER_BUILD_ID OFF CACHE BOOL "pass --build-id to ld")

set(ENABLE_X86_RELAX_RELOCATIONS ON CACHE BOOL
Expand Down
6 changes: 6 additions & 0 deletions clang/include/clang/Config/config.h.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,10 @@
/* Whether CIR is built into Clang */
#cmakedefine01 CLANG_ENABLE_CIR

/* Whether to use xcselect to find the macOS SDK */
#cmakedefine CLANG_USE_XCSELECT

/* Policy to use for xcselect */
#cmakedefine CLANG_XCSELECT_HOST_SDK_POLICY ${CLANG_XCSELECT_HOST_SDK_POLICY}

#endif
4 changes: 4 additions & 0 deletions clang/lib/Driver/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ if(WIN32)
set(system_libs version)
endif()

if(CLANG_USE_XCSELECT)
set(system_libs xcselect)
endif()

add_clang_library(clangDriver
Action.cpp
Compilation.cpp
Expand Down
32 changes: 23 additions & 9 deletions clang/lib/Driver/ToolChains/Darwin.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@
#include "llvm/TargetParser/Triple.h"
#include <cstdlib> // ::getenv

#ifdef CLANG_USE_XCSELECT
#include <xcselect.h> // ::xcselect_host_sdk_path
#endif

using namespace clang::driver;
using namespace clang::driver::tools;
using namespace clang::driver::toolchains;
Expand Down Expand Up @@ -2257,17 +2261,27 @@ void Darwin::AddDeploymentTarget(DerivedArgList &Args) const {
// Warn if the path does not exist.
if (!getVFS().exists(A->getValue()))
getDriver().Diag(clang::diag::warn_missing_sysroot) << A->getValue();
} else {
if (char *env = ::getenv("SDKROOT")) {
// We only use this value as the default if it is an absolute path,
// exists, and it is not the root path.
if (llvm::sys::path::is_absolute(env) && getVFS().exists(env) &&
StringRef(env) != "/") {
Args.append(Args.MakeSeparateArg(
nullptr, Opts.getOption(options::OPT_isysroot), env));
}
} else if (const char *env = ::getenv("SDKROOT")) {
// We only use this value as the default if it is an absolute path,
// exists, and it is not the root path.
if (llvm::sys::path::is_absolute(env) && getVFS().exists(env) &&
StringRef(env) != "/") {
Args.append(Args.MakeSeparateArg(
nullptr, Opts.getOption(options::OPT_isysroot), env));
}
}
#ifdef CLANG_USE_XCSELECT
// FIXME: This should check for `getTriple().isMacOSX()`, but this breaks
// many tests. See https://github.com/llvm/llvm-project/pull/119670.
else if (getTriple().getOS() == llvm::Triple::MacOSX) {
char *p;
if (!::xcselect_host_sdk_path(CLANG_XCSELECT_HOST_SDK_POLICY, &p)) {
Args.append(Args.MakeSeparateArg(
nullptr, Opts.getOption(options::OPT_isysroot), p));
::free(p);
}
}
#endif

// Read the SDKSettings.json file for more information, like the SDK version
// that we can pass down to the compiler.
Expand Down
1 change: 1 addition & 0 deletions clang/test/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ llvm_canonicalize_cmake_booleans(
CLANG_PLUGIN_SUPPORT
CLANG_SPAWN_CC1
CLANG_ENABLE_CIR
CLANG_USE_XCSELECT
ENABLE_BACKTRACES
LLVM_BUILD_EXAMPLES
LLVM_BYE_LINK_INTO_TOOLS
Expand Down
12 changes: 12 additions & 0 deletions clang/test/Driver/darwin-ld-platform-version-macos-nosdk.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// UNSUPPORTED: xcselect
// CLANG_USE_XCSELECT will always have an SDK inferred.

// RUN: touch %t.o

// RUN: %clang -target x86_64-apple-macos10.13 -mlinker-version=520 \
// RUN: -### %t.o 2>&1 \
// RUN: | FileCheck --check-prefix=NOSDK %s
// RUN: %clang -target x86_64-apple-darwin17 -mlinker-version=520 \
// RUN: -### %t.o 2>&1 \
// RUN: | FileCheck --check-prefix=NOSDK %s
// NOSDK: "-platform_version" "macos" "10.13.0" "10.13.0"
6 changes: 3 additions & 3 deletions clang/test/Driver/darwin-ld-platform-version-macos.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@

// RUN: %clang -target x86_64-apple-macos10.13 -mlinker-version=520 \
// RUN: -### %t.o 2>&1 \
// RUN: | FileCheck --check-prefix=NOSDK %s
// RUN: | FileCheck --check-prefix=INFERRED-SDK %s
Copy link
Collaborator

@cachemeifyoucan cachemeifyoucan Dec 13, 2024

Choose a reason for hiding this comment

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

I think you want to delete those two. The test will fail if no CLANG_USE_XCSELECT is used.

Copy link
Member Author

@carlocab carlocab Dec 13, 2024

Choose a reason for hiding this comment

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

I think they'll pass since I've just relaxed the text to match against. But I'll double check locally for both enabling and disabling CLANG_USE_XCSELECT and delete them if it fails.

Copy link
Collaborator

@cachemeifyoucan cachemeifyoucan Dec 13, 2024

Choose a reason for hiding this comment

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

I see. The value of the test is to check the behavior of matching the version when SDK is not provided. I don't think current test provide any value.

Copy link
Member Author

@carlocab carlocab Dec 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I think it does provide some value, particularly for builds with CLANG_USE_XCSELECT=ON (since there is a stricter test that was separated out for builds where it is disabled).

That is, we check that the first two arguments to -platform_version, "macos" and "10.13.0", are correctly inferred from -target, and that the last argument looks like a version scheme, even when no -isysroot flag is provided.

That still seems valuable to me, even if it's not the same as the original test.

However, if you're still not convinced, I can remove it.

// RUN: %clang -target x86_64-apple-darwin17 -mlinker-version=520 \
// RUN: -### %t.o 2>&1 \
// RUN: | FileCheck --check-prefix=NOSDK %s
// NOSDK: "-platform_version" "macos" "10.13.0" "10.13.0"
// RUN: | FileCheck --check-prefix=INFERRED-SDK %s
// INFERRED-SDK: "-platform_version" "macos" "10.13.0" "{{[0-9]+(\.[0-9]+)*}}"
5 changes: 5 additions & 0 deletions clang/test/Driver/xcselect.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// REQUIRES: xcselect
// RUN: %clang -target arm64-apple-macosx -c -### %s 2> %t.log
// RUN: FileCheck %s <%t.log

// CHECK: "-isysroot" "{{.*}}/SDKs/MacOSX{{([0-9]+(\.[0-9]+)?)?}}.sdk"
2 changes: 2 additions & 0 deletions clang/test/lit.cfg.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,8 @@ def calculate_arch_features(arch_string):
if config.have_llvm_driver:
config.available_features.add("llvm-driver")

if config.use_xcselect:
config.available_features.add("xcselect")

# Some tests perform deep recursion, which requires a larger pthread stack size
# than the relatively low default of 192 KiB for 64-bit processes on AIX. The
Expand Down
1 change: 1 addition & 0 deletions clang/test/lit.site.cfg.py.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ config.standalone_build = @CLANG_BUILT_STANDALONE@
config.ppc_linux_default_ieeelongdouble = @PPC_LINUX_DEFAULT_IEEELONGDOUBLE@
config.have_llvm_driver = @LLVM_TOOL_LLVM_DRIVER_BUILD@
config.substitutions.append(("%llvm-version-major", "@LLVM_VERSION_MAJOR@"))
config.use_xcselect = @CLANG_USE_XCSELECT@

import lit.llvm
lit.llvm.initialize(lit_config, config)
Expand Down
Loading