https://github.com/ian-twilightcoder created https://github.com/llvm/llvm-project/pull/178115
The SDK's SupportedTarget for its CanonicalName doesn't necessarily have an LLVMTargetTripleSys/LLVMTargetTripleEnvironment that matches the CanonicalName. e.g. sometimes new SDKs use arm64-apple-ios1.0 during bringup, but their CanonicalName is set to the new platform. Go back to using CanonicalName to identify the SDK as a Triple::OSType, and expose the Triple::EnvironmentType used to build the SDKPlatformInfo when SupportedTargets isn't present. >From 77ba776caba8eaa494e63e765804fd9bd5b60114 Mon Sep 17 00:00:00 2001 From: Ian Anderson <[email protected]> Date: Sat, 24 Jan 2026 01:34:17 -0800 Subject: [PATCH] [clang][driver][darwin] Switch back to using CanonicalName to identify the SDK instead of SupportedTargets The SDK's SupportedTarget for its CanonicalName doesn't necessarily have an LLVMTargetTripleSys/LLVMTargetTripleEnvironment that matches the CanonicalName. e.g. sometimes new SDKs use arm64-apple-ios1.0 during bringup, but their CanonicalName is set to the new platform. Go back to using CanonicalName to identify the SDK as a Triple::OSType, and expose the Triple::EnvironmentType used to build the SDKPlatformInfo when SupportedTargets isn't present. --- clang/include/clang/Basic/DarwinSDKInfo.h | 11 +- clang/lib/Basic/DarwinSDKInfo.cpp | 107 ++++++++++-------- clang/lib/Driver/ToolChains/Darwin.cpp | 27 +++-- .../Inputs/FakeOS1.0.sdk/SDKSettings.json | 27 +++++ clang/test/Driver/darwin-builtin-modules.c | 23 ++-- 5 files changed, 125 insertions(+), 70 deletions(-) create mode 100644 clang/test/Driver/Inputs/FakeOS1.0.sdk/SDKSettings.json diff --git a/clang/include/clang/Basic/DarwinSDKInfo.h b/clang/include/clang/Basic/DarwinSDKInfo.h index ae44b953e1e4c..ebacadb2b2bc9 100644 --- a/clang/include/clang/Basic/DarwinSDKInfo.h +++ b/clang/include/clang/Basic/DarwinSDKInfo.h @@ -181,7 +181,8 @@ class DarwinSDKInfo { using PlatformInfoStorageType = SmallVector<SDKPlatformInfo, 2>; DarwinSDKInfo( - std::string FilePath, VersionTuple Version, + std::string FilePath, llvm::Triple::OSType OS, + llvm::Triple::EnvironmentType Environment, VersionTuple Version, VersionTuple MaximumDeploymentTarget, PlatformInfoStorageType PlatformInfos, llvm::DenseMap<OSEnvPair::StorageType, @@ -189,13 +190,17 @@ class DarwinSDKInfo { VersionMappings = llvm::DenseMap<OSEnvPair::StorageType, std::optional<RelatedTargetVersionMapping>>()) - : FilePath(FilePath), Version(Version), + : FilePath(FilePath), OS(OS), Environment(Environment), Version(Version), MaximumDeploymentTarget(MaximumDeploymentTarget), PlatformInfos(std::move(PlatformInfos)), VersionMappings(std::move(VersionMappings)) {} StringRef getFilePath() const { return FilePath; } + llvm::Triple::OSType getOS() const { return OS; } + + llvm::Triple::EnvironmentType getEnvironment() const { return Environment; } + const llvm::VersionTuple &getVersion() const { return Version; } const SDKPlatformInfo &getCanonicalPlatformInfo() const { @@ -233,6 +238,8 @@ class DarwinSDKInfo { private: std::string FilePath; + llvm::Triple::OSType OS; + llvm::Triple::EnvironmentType Environment; VersionTuple Version; VersionTuple MaximumDeploymentTarget; PlatformInfoStorageType PlatformInfos; diff --git a/clang/lib/Basic/DarwinSDKInfo.cpp b/clang/lib/Basic/DarwinSDKInfo.cpp index 4fa2febe0f650..839bb5a16b5de 100644 --- a/clang/lib/Basic/DarwinSDKInfo.cpp +++ b/clang/lib/Basic/DarwinSDKInfo.cpp @@ -63,59 +63,58 @@ DarwinSDKInfo::RelatedTargetVersionMapping::parseJSON( Min, Max, MinValue, MaximumDeploymentTarget, std::move(Mapping)); } -static DarwinSDKInfo::PlatformInfoStorageType -parsePlatformInfos(const llvm::json::Object &Obj, VersionTuple Version) { +static std::optional<StringRef> +parseXcodePlatform(const llvm::json::Object &Obj) { // The CanonicalName is the Xcode platform followed by a version, e.g. - // macosx15.0. The associated SDKPlatformInfo must be the first entry in the - // returned PlatformInfoStorageType. - StringRef XcodePlatform; - if (auto CanonicalName = Obj.getString("CanonicalName")) { - size_t VersionStart = CanonicalName->find_first_of("0123456789"); - XcodePlatform = CanonicalName->slice(0, VersionStart); - } + // macosx15.0. + auto CanonicalName = Obj.getString("CanonicalName"); + if (!CanonicalName) + return std::nullopt; + size_t VersionStart = CanonicalName->find_first_of("0123456789"); + return CanonicalName->slice(0, VersionStart); +} + +static std::pair<llvm::Triple::OSType, llvm::Triple::EnvironmentType> +parseOSAndEnvironment(const llvm::json::Object &Obj, + std::optional<StringRef> XcodePlatform) { + if (!XcodePlatform) + return {llvm::Triple::UnknownOS, llvm::Triple::UnknownEnvironment}; + + llvm::Triple::OSType OS = + llvm::StringSwitch<llvm::Triple::OSType>(*XcodePlatform) + .Case("macosx", llvm::Triple::MacOSX) + .Cases({"iphoneos", "iphonesimulator"}, llvm::Triple::IOS) + .Cases({"appletvos", "appletvsimulator"}, llvm::Triple::TvOS) + .Cases({"watchos", "watchsimulator"}, llvm::Triple::WatchOS) + .Case("bridgeos", llvm::Triple::BridgeOS) + .Cases({"xros", "xrsimulator"}, llvm::Triple::XROS) + .Case("driverkit", llvm::Triple::DriverKit) + .Default(llvm::Triple::UnknownOS); + llvm::Triple::EnvironmentType Environment = + llvm::StringSwitch<llvm::Triple::EnvironmentType>(*XcodePlatform) + .Cases({"iphonesimulator", "appletvsimulator", "watchsimulator", + "xrsimulator"}, + llvm::Triple::Simulator) + .Default(llvm::Triple::UnknownEnvironment); + + return {OS, Environment}; +} + +static DarwinSDKInfo::PlatformInfoStorageType parsePlatformInfos( + const llvm::json::Object &Obj, std::optional<StringRef> XcodePlatform, + llvm::Triple::OSType SDKOS, llvm::Triple::EnvironmentType SDKEnvironment, + VersionTuple Version) { DarwinSDKInfo::PlatformInfoStorageType PlatformInfos; auto SupportedTargets = Obj.getObject("SupportedTargets"); if (!SupportedTargets) { - // For older SDKs that don't have SupportedTargets, infer one from the Xcode - // platform. - if (XcodePlatform == "macosx") { - PlatformInfos.push_back({llvm::Triple::Apple, llvm::Triple::MacOSX, - llvm::Triple::UnknownEnvironment, - llvm::Triple::MachO, ""}); - } else if (XcodePlatform == "iphoneos") { - PlatformInfos.push_back({llvm::Triple::Apple, llvm::Triple::IOS, - llvm::Triple::UnknownEnvironment, - llvm::Triple::MachO, ""}); - } else if (XcodePlatform == "iphonesimulator") { - PlatformInfos.push_back({llvm::Triple::Apple, llvm::Triple::IOS, - llvm::Triple::Simulator, llvm::Triple::MachO, - ""}); - } else if (XcodePlatform == "appletvos") { - PlatformInfos.push_back({llvm::Triple::Apple, llvm::Triple::TvOS, - llvm::Triple::UnknownEnvironment, - llvm::Triple::MachO, ""}); - } else if (XcodePlatform == "appletvsimulator") { - PlatformInfos.push_back({llvm::Triple::Apple, llvm::Triple::TvOS, - llvm::Triple::Simulator, llvm::Triple::MachO, - ""}); - } else if (XcodePlatform == "watchos") { - PlatformInfos.push_back({llvm::Triple::Apple, llvm::Triple::WatchOS, - llvm::Triple::UnknownEnvironment, - llvm::Triple::MachO, ""}); - } else if (XcodePlatform == "watchsimulator") { - PlatformInfos.push_back({llvm::Triple::Apple, llvm::Triple::WatchOS, - llvm::Triple::Simulator, llvm::Triple::MachO, - ""}); - } else if (XcodePlatform == "driverkit") { - PlatformInfos.push_back({llvm::Triple::Apple, llvm::Triple::DriverKit, - llvm::Triple::UnknownEnvironment, - llvm::Triple::MachO, "/System/DriverKit"}); - } else { - llvm::reportFatalUsageError( - "Unrecognized CanonicalName in SDKSettings.json. SupportedTargets is " - "expected, or a recognized CanonicalName."); - } + // For older SDKs that don't have SupportedTargets, infer one from the SDK's + // OS/Environment. + StringRef PlatformPrefix; + if (SDKOS == llvm::Triple::DriverKit) + PlatformPrefix = "/System/DriverKit"; + PlatformInfos.push_back({llvm::Triple::Apple, SDKOS, SDKEnvironment, + llvm::Triple::MachO, PlatformPrefix}); return PlatformInfos; } @@ -136,6 +135,8 @@ parsePlatformInfos(const llvm::json::Object &Obj, VersionTuple Version) { else Triple = llvm::Triple(Arch, *Vendor, *OS); + // The key is either the Xcode platform, or a variant. The platform must be + // the first entry in the returned PlatformInfoStorageType. StringRef PlatformOrVariant = SupportedTargetPair.getFirst(); StringRef EffectivePlatformPrefix; @@ -185,7 +186,12 @@ DarwinSDKInfo::parseDarwinSDKSettingsJSON(std::string FilePath, getVersionKey(*Obj, "MaximumDeploymentTarget"); if (!MaximumDeploymentVersion) return std::nullopt; - PlatformInfoStorageType PlatformInfos = parsePlatformInfos(*Obj, *Version); + std::optional<StringRef> XcodePlatform = parseXcodePlatform(*Obj); + std::pair<llvm::Triple::OSType, llvm::Triple::EnvironmentType> + OSAndEnvironment = parseOSAndEnvironment(*Obj, XcodePlatform); + PlatformInfoStorageType PlatformInfos = + parsePlatformInfos(*Obj, XcodePlatform, OSAndEnvironment.first, + OSAndEnvironment.second, *Version); llvm::DenseMap<OSEnvPair::StorageType, std::optional<RelatedTargetVersionMapping>> VersionMappings; @@ -227,7 +233,8 @@ DarwinSDKInfo::parseDarwinSDKSettingsJSON(std::string FilePath, } } - return DarwinSDKInfo(std::move(FilePath), std::move(*Version), + return DarwinSDKInfo(std::move(FilePath), OSAndEnvironment.first, + OSAndEnvironment.second, std::move(*Version), std::move(*MaximumDeploymentVersion), std::move(PlatformInfos), std::move(VersionMappings)); } diff --git a/clang/lib/Driver/ToolChains/Darwin.cpp b/clang/lib/Driver/ToolChains/Darwin.cpp index e29cc087fe69e..dfd9b713d3feb 100644 --- a/clang/lib/Driver/ToolChains/Darwin.cpp +++ b/clang/lib/Driver/ToolChains/Darwin.cpp @@ -1914,14 +1914,16 @@ struct DarwinPlatform { DarwinSDKInfo inferSDKInfo() { assert(Kind == InferredFromSDK && "can infer SDK info only"); llvm::Triple::OSType OS = getOSFromPlatform(Platform); + llvm::Triple::EnvironmentType EnvironmentType = + getEnvironmentTypeFromEnvironmentKind(Environment); StringRef PlatformPrefix = (Platform == DarwinPlatformKind::DriverKit) ? "/System/DriverKit" : ""; return DarwinSDKInfo( - "", getOSVersion(), /*MaximumDeploymentTarget=*/ + "", OS, EnvironmentType, getOSVersion(), /*MaximumDeploymentTarget=*/ VersionTuple(getOSVersion().getMajor(), 0, 99), {DarwinSDKInfo::SDKPlatformInfo(llvm::Triple::Apple, OS, - llvm::Triple::UnknownEnvironment, - llvm::Triple::MachO, PlatformPrefix)}); + EnvironmentType, llvm::Triple::MachO, + PlatformPrefix)}); } private: @@ -1982,6 +1984,19 @@ struct DarwinPlatform { llvm_unreachable("Unknown DarwinPlatformKind enum"); } + static llvm::Triple::EnvironmentType + getEnvironmentTypeFromEnvironmentKind(DarwinEnvironmentKind EnvironmentKind) { + switch (EnvironmentKind) { + case DarwinEnvironmentKind::NativeEnvironment: + return llvm::Triple::UnknownEnvironment; + case DarwinEnvironmentKind::Simulator: + return llvm::Triple::Simulator; + case DarwinEnvironmentKind::MacCatalyst: + return llvm::Triple::MacABI; + } + llvm_unreachable("Unknown DarwinEnvironmentKind enum"); + } + SourceKind Kind; DarwinPlatformKind Platform; DarwinEnvironmentKind Environment = DarwinEnvironmentKind::NativeEnvironment; @@ -3138,9 +3153,7 @@ sdkSupportsBuiltinModules(const std::optional<DarwinSDKInfo> &SDKInfo) { // the old behavior which is to not use builtin modules. return false; - DarwinSDKInfo::SDKPlatformInfo PlatformInfo = - SDKInfo->getCanonicalPlatformInfo(); - switch (PlatformInfo.getEnvironment()) { + switch (SDKInfo->getEnvironment()) { case llvm::Triple::UnknownEnvironment: case llvm::Triple::Simulator: case llvm::Triple::MacABI: @@ -3153,7 +3166,7 @@ sdkSupportsBuiltinModules(const std::optional<DarwinSDKInfo> &SDKInfo) { } VersionTuple SDKVersion = SDKInfo->getVersion(); - switch (PlatformInfo.getOS()) { + switch (SDKInfo->getOS()) { // Existing SDKs added support for builtin modules in the fall // 2024 major releases. case llvm::Triple::MacOSX: diff --git a/clang/test/Driver/Inputs/FakeOS1.0.sdk/SDKSettings.json b/clang/test/Driver/Inputs/FakeOS1.0.sdk/SDKSettings.json new file mode 100644 index 0000000000000..c3872ce6b2905 --- /dev/null +++ b/clang/test/Driver/Inputs/FakeOS1.0.sdk/SDKSettings.json @@ -0,0 +1,27 @@ +{ + "CanonicalName": "fakeos1.0", + "Version": "1.0", + "IsBaseSDK": "YES", + "DisplayName": "fakeOS 1.0", + "MinimalDisplayName": "1.0", + "SupportedTargets": { + "fakeos": { + "PlatformFamilyName": "fakeOS", + "PlatformFamilyDisplayName": "fakeOS", + "Archs": ["arm64e", "arm64"], "LLVMTargetTripleVendor": "apple", "LLVMTargetTripleSys": "ios", "LLVMTargetTripleEnvironment": "", + "BuildVersionPlatformID": "11", + "ClangRuntimeLibraryPlatformName": "ios", + "SystemPrefix": "", + "DefaultDeploymentTarget": "1.0", + "RecommendedDeploymentTarget": "1.0", + "MinimumDeploymentTarget": "1.0", "MaximumDeploymentTarget": "1.0.99", + "ValidDeploymentTargets": ["1.0"] + } + }, + "VersionMap": { + "fakeOS_iOS": {"1.0": "26.0"}, + "iOS_fakeOS": {"26.0": "1.0"} + }, + "DefaultDeploymentTarget": "1.0", + "MaximumDeploymentTarget": "1.0.99" +} diff --git a/clang/test/Driver/darwin-builtin-modules.c b/clang/test/Driver/darwin-builtin-modules.c index 24b817545eca8..f4c9220b8d577 100644 --- a/clang/test/Driver/darwin-builtin-modules.c +++ b/clang/test/Driver/darwin-builtin-modules.c @@ -1,15 +1,16 @@ // Check that darwin passes -fbuiltin-headers-in-system-modules // when expected. -// RUN: %clang -target x86_64-apple-darwin22.4 -### %s 2>&1 | FileCheck %s -// RUN: %clang -isysroot %S/Inputs/MacOSX10.15.sdk -target x86_64-apple-macos10.15 -### %s 2>&1 | FileCheck %s -// RUN: %clang -isysroot %S/Inputs/iPhoneOS13.0.sdk -target arm64-apple-ios13.0 -### %s 2>&1 | FileCheck %s -// CHECK: -fbuiltin-headers-in-system-modules +// RUN: %clang -target x86_64-apple-darwin22.4 -### %s 2>&1 | FileCheck --check-prefix=CHECK_OLD %s +// RUN: %clang -isysroot %S/Inputs/MacOSX10.15.sdk -target x86_64-apple-macos10.15 -### %s 2>&1 | FileCheck --check-prefix=CHECK_OLD %s +// RUN: %clang -isysroot %S/Inputs/iPhoneOS13.0.sdk -target arm64-apple-ios13.0 -### %s 2>&1 | FileCheck --check-prefix=CHECK_OLD %s +// CHECK_OLD: -fbuiltin-headers-in-system-modules -// RUN: %clang -isysroot %S/Inputs/MacOSX15.0.sdk -target x86_64-apple-macos14.0 -### %s 2>&1 | FileCheck --check-prefix=CHECK_FUTURE %s -// RUN: %clang -isysroot %S/Inputs/MacOSX15.0.sdk -target x86_64-apple-macos15.0 -### %s 2>&1 | FileCheck --check-prefix=CHECK_FUTURE %s -// RUN: %clang -isysroot %S/Inputs/MacOSX15.0.sdk -target x86_64-apple-ios18.0-macabi -### %s 2>&1 | FileCheck --check-prefix=CHECK_FUTURE %s -// RUN: %clang -isysroot %S/Inputs/MacOSX15.1.sdk -target x86_64-apple-macos15.1 -darwin-target-variant x86_64-apple-ios18.1-macabi -### %s 2>&1 | FileCheck --check-prefix=CHECK_FUTURE %s -// RUN: %clang -isysroot %S/Inputs/MacOSX15.1.sdk -target x86_64-apple-ios18.1-macabi -darwin-target-variant x86_64-apple-macos15.1 -### %s 2>&1 | FileCheck --check-prefix=CHECK_FUTURE %s -// RUN: %clang -isysroot %S/Inputs/DriverKit23.0.sdk -target arm64-apple-driverkit23.0 -### %s 2>&1 | FileCheck --check-prefix=CHECK_FUTURE %s -// CHECK_FUTURE-NOT: -fbuiltin-headers-in-system-modules +// RUN: %clang -isysroot %S/Inputs/MacOSX15.0.sdk -target x86_64-apple-macos14.0 -### %s 2>&1 | FileCheck --check-prefix=CHECK_NEW %s +// RUN: %clang -isysroot %S/Inputs/MacOSX15.0.sdk -target x86_64-apple-macos15.0 -### %s 2>&1 | FileCheck --check-prefix=CHECK_NEW %s +// RUN: %clang -isysroot %S/Inputs/MacOSX15.0.sdk -target x86_64-apple-ios18.0-macabi -### %s 2>&1 | FileCheck --check-prefix=CHECK_NEW %s +// RUN: %clang -isysroot %S/Inputs/MacOSX15.1.sdk -target x86_64-apple-macos15.1 -darwin-target-variant x86_64-apple-ios18.1-macabi -### %s 2>&1 | FileCheck --check-prefix=CHECK_NEW %s +// RUN: %clang -isysroot %S/Inputs/MacOSX15.1.sdk -target x86_64-apple-ios18.1-macabi -darwin-target-variant x86_64-apple-macos15.1 -### %s 2>&1 | FileCheck --check-prefix=CHECK_NEW %s +// RUN: %clang -isysroot %S/Inputs/DriverKit23.0.sdk -target arm64-apple-driverkit23.0 -### %s 2>&1 | FileCheck --check-prefix=CHECK_NEW %s +// RUN: %clang -isysroot %S/Inputs/FakeOS1.0.sdk -target arm64-apple-ios1.0 -### %s 2>&1 | FileCheck --check-prefix=CHECK_NEW %s +// CHECK_NEW-NOT: -fbuiltin-headers-in-system-modules _______________________________________________ cfe-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
