https://github.com/carlocab updated 
https://github.com/llvm/llvm-project/pull/119670

>From 9db768ec1be84d6bf647b85f052776720822f64f Mon Sep 17 00:00:00 2001
From: Carlo Cabrera <git...@carlo.cab>
Date: Tue, 10 Dec 2024 01:45:22 +0800
Subject: [PATCH 1/3] [clang][Driver][Darwin] Optionally use xcselect to find
 macOS SDK

This is a scaled down version of https://reviews.llvm.org/D136315.

The intent is largely the same as before[^1], but I've scaled down the scope
to try to avoid the issues that the previous patch caused:
- the changes are now opt-in based on enabling `CLANG_USE_XCSELECT`
- this only works when targeting macOS on a macOS host (this is the only
  case supported by `libxcselect`[^2])

We also introduce an environment variable `CLANG_NO_XCSELECT` that
disables this behaviour if Clang is configured with
`CLANG_USE_XCSELECT=ON`. This is needed to avoid breaking tests.

Another reason to leave this as opt-in for now is that there are some
bugs in libxcselect that need fixing before it is safe to use by default
for all users. This has been reported to Apple as FB16081077.

[^1]: See also https://reviews.llvm.org/D109460 and #45225.
[^2]: https://developer.apple.com/documentation/xcselect?language=objc
---
 clang/CMakeLists.txt                      | 33 +++++++++++++++++++++++
 clang/include/clang/Config/config.h.cmake |  6 +++++
 clang/lib/Driver/CMakeLists.txt           |  4 +++
 clang/lib/Driver/ToolChains/Darwin.cpp    | 31 ++++++++++++++-------
 clang/test/lit.cfg.py                     |  4 +++
 5 files changed, 69 insertions(+), 9 deletions(-)

diff --git a/clang/CMakeLists.txt b/clang/CMakeLists.txt
index 27e8095534a65c..3c7096a27c509b 100644
--- a/clang/CMakeLists.txt
+++ b/clang/CMakeLists.txt
@@ -214,6 +214,39 @@ if(GCC_INSTALL_PREFIX AND NOT 
USE_DEPRECATED_GCC_INSTALL_PREFIX)
     "See https://github.com/llvm/llvm-project/pull/77537 for detail.")
 endif()
 
+if(APPLE)
+  check_include_file(xcselect.h CLANG_HAVE_XCSELECT_H)
+  if(CLANG_HAVE_XCSELECT_H)
+    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)
+  endif()
+endif()
+
+cmake_dependent_option(CLANG_USE_XCSELECT "Use libxcselect to find the macOS 
SDK." OFF
+  "APPLE;CLANG_HAVE_XCSELECT_HOST_SDK_PATH" OFF)
+
+if(DEFAULT_SYSROOT AND CLANG_USE_XCSELECT)
+  message(FATAL_ERROR "Setting DEFAULT_SYSROOT is incompatible with 
CLANG_USE_XCSELECT.")
+endif()
+
+if(CLANG_USE_XCSELECT)
+  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
diff --git a/clang/include/clang/Config/config.h.cmake 
b/clang/include/clang/Config/config.h.cmake
index 27ed69e21562bf..9ae0c6a4b9e11d 100644
--- a/clang/include/clang/Config/config.h.cmake
+++ b/clang/include/clang/Config/config.h.cmake
@@ -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
diff --git a/clang/lib/Driver/CMakeLists.txt b/clang/lib/Driver/CMakeLists.txt
index 4fd10bf671512f..299de2ef30470c 100644
--- a/clang/lib/Driver/CMakeLists.txt
+++ b/clang/lib/Driver/CMakeLists.txt
@@ -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
diff --git a/clang/lib/Driver/ToolChains/Darwin.cpp 
b/clang/lib/Driver/ToolChains/Darwin.cpp
index 87380869f6fdab..8d3e0130a5a432 100644
--- a/clang/lib/Driver/ToolChains/Darwin.cpp
+++ b/clang/lib/Driver/ToolChains/Darwin.cpp
@@ -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;
@@ -2257,17 +2261,26 @@ 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"); env && *env) {
+    // 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
+  else if (const char *env = ::getenv("CLANG_NO_XCSELECT");
+           getTriple().isMacOSX() && (!env || !*env)) {
+    if (char *p;
+        !::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.
diff --git a/clang/test/lit.cfg.py b/clang/test/lit.cfg.py
index 7e7934d5fe0f5f..d05ad1ec6c5fa6 100644
--- a/clang/test/lit.cfg.py
+++ b/clang/test/lit.cfg.py
@@ -366,3 +366,7 @@ def calculate_arch_features(arch_string):
 # possibly be present in system and user configuration files, so disable
 # default configs for the test runs.
 config.environment["CLANG_NO_DEFAULT_CONFIG"] = "1"
+
+# Configuring clang with CLANG_USE_XCSELECT=ON breaks some tests, so disable
+# its behaviour while running tests.
+config.environment["CLANG_NO_XCSELECT"] = "1"

>From 8b5afe0871ece184fb1484dd0221721e4d42863c Mon Sep 17 00:00:00 2001
From: Carlo Cabrera <git...@carlo.cab>
Date: Fri, 13 Dec 2024 02:32:17 +0800
Subject: [PATCH 2/3] Gate all `xcselect` checks behind `CLANG_USE_XCSELECT`

---
 clang/CMakeLists.txt | 31 ++++++++++++++++++-------------
 1 file changed, 18 insertions(+), 13 deletions(-)

diff --git a/clang/CMakeLists.txt b/clang/CMakeLists.txt
index 3c7096a27c509b..5cdc573ac24660 100644
--- a/clang/CMakeLists.txt
+++ b/clang/CMakeLists.txt
@@ -214,30 +214,35 @@ if(GCC_INSTALL_PREFIX AND NOT 
USE_DEPRECATED_GCC_INSTALL_PREFIX)
     "See https://github.com/llvm/llvm-project/pull/77537 for detail.")
 endif()
 
-if(APPLE)
+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(CLANG_HAVE_XCSELECT_H)
-    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_H)
+    message(FATAL_ERROR "CLANG_USE_XCSELECT is enabled but xcselect.h was not 
found.")
   endif()
-endif()
 
-cmake_dependent_option(CLANG_USE_XCSELECT "Use libxcselect to find the macOS 
SDK." OFF
-  "APPLE;CLANG_HAVE_XCSELECT_HOST_SDK_PATH" OFF)
+  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(DEFAULT_SYSROOT AND CLANG_USE_XCSELECT)
-  message(FATAL_ERROR "Setting DEFAULT_SYSROOT is incompatible with 
CLANG_USE_XCSELECT.")
-endif()
+  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()
 
-if(CLANG_USE_XCSELECT)
   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

>From 27a5e1920c33b16d866ac32b4e1ec1c4ca4a6935 Mon Sep 17 00:00:00 2001
From: Carlo Cabrera <git...@carlo.cab>
Date: Fri, 13 Dec 2024 02:37:10 +0800
Subject: [PATCH 3/3] Avoid `if` conditions with multiple statements

---
 clang/lib/Driver/ToolChains/Darwin.cpp | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/clang/lib/Driver/ToolChains/Darwin.cpp 
b/clang/lib/Driver/ToolChains/Darwin.cpp
index 8d3e0130a5a432..b6b288b93f766b 100644
--- a/clang/lib/Driver/ToolChains/Darwin.cpp
+++ b/clang/lib/Driver/ToolChains/Darwin.cpp
@@ -2261,7 +2261,7 @@ 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 (const char *env = ::getenv("SDKROOT"); env && *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) &&
@@ -2271,13 +2271,16 @@ void Darwin::AddDeploymentTarget(DerivedArgList &Args) 
const {
     }
   }
 #ifdef CLANG_USE_XCSELECT
-  else if (const char *env = ::getenv("CLANG_NO_XCSELECT");
-           getTriple().isMacOSX() && (!env || !*env)) {
-    if (char *p;
-        !::xcselect_host_sdk_path(CLANG_XCSELECT_HOST_SDK_POLICY, &p)) {
-      Args.append(Args.MakeSeparateArg(
-          nullptr, Opts.getOption(options::OPT_isysroot), p));
-      ::free(p);
+  else if (getTriple().isMacOSX()) {
+    const char *env = ::getenv("CLANG_NO_XCSELECT");
+
+    if (!env || !*env) {
+      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

_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

Reply via email to