[clang][Driver] Support simplified triple versions for config files #111387
+62
−14
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thank you for submitting a Pull Request (PR) to the LLVM Project! This PR will be automatically labeled and the relevant teams will be notified. If you wish to, you can add reviewers by using the "Reviewers" section on this page. If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers. If you have further questions, they may be answered by the LLVM GitHub User Guide. You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums. |
llvmbot
added
clang
|
@llvm/pr-subscribers-clang Author: Bo Anderson (Bo98) ChangesCurrently, the config file system loads the full target triple, e.g. This is however not very useful as this is a moving target. In the case of macOS, that target moves every 2 months. We can improve this by adding fallbacks that simplify the version component of the triple. This pull request adds support for loading Full diff: https://github.com/llvm/llvm-project/pull/111387.diff 2 Files Affected:
diff --git a/clang/lib/Driver/Driver.cpp b/clang/lib/Driver/Driver.cpp
index a5d43bdac23735..26aa7f67842ce9 100644
--- a/clang/lib/Driver/Driver.cpp
+++ b/clang/lib/Driver/Driver.cpp
@@ -1147,6 +1147,34 @@ bool Driver::loadConfigFiles() {
return false;
}
+static bool findTripleConfigFile(llvm::cl::ExpansionContext &ExpCtx,
+ SmallString<128> &ConfigFilePath,
+ llvm::Triple Triple, std::string Suffix) {
+ // First, try the full unmodified triple.
+ if (ExpCtx.findConfigFile(Triple.str() + Suffix, ConfigFilePath))
+ return true;
+
+ // Don't continue if we didn't find a parsable version in the triple.
+ VersionTuple OSVersion = Triple.getOSVersion();
+ if (!OSVersion.getMinor().has_value())
+ return false;
+
+ std::string BaseOSName = Triple.getOSTypeName(Triple.getOS()).str();
+
+ // Next try strip the version to only include the major component.
+ // e.g. arm64-apple-darwin23.6.0 -> arm64-apple-darwin23
+ if (OSVersion.getMajor() != 0) {
+ Triple.setOSName(BaseOSName + llvm::utostr(OSVersion.getMajor()));
+ if (ExpCtx.findConfigFile(Triple.str() + Suffix, ConfigFilePath))
+ return true;
+ }
+
+ // Finally, try without any version suffix at all.
+ // e.g. arm64-apple-darwin23.6.0 -> arm64-apple-darwin
+ Triple.setOSName(BaseOSName);
+ return ExpCtx.findConfigFile(Triple.str() + Suffix, ConfigFilePath);
+}
+
bool Driver::loadDefaultConfigFiles(llvm::cl::ExpansionContext &ExpCtx) {
// Disable default config if CLANG_NO_DEFAULT_CONFIG is set to a non-empty
// value.
@@ -1158,7 +1186,7 @@ bool Driver::loadDefaultConfigFiles(llvm::cl::ExpansionContext &ExpCtx) {
return false;
std::string RealMode = getExecutableForDriverMode(Mode);
- std::string Triple;
+ llvm::Triple Triple;
// If name prefix is present, no --target= override was passed via CLOptions
// and the name prefix is not a valid triple, force it for backwards
@@ -1169,15 +1197,13 @@ bool Driver::loadDefaultConfigFiles(llvm::cl::ExpansionContext &ExpCtx) {
llvm::Triple PrefixTriple{ClangNameParts.TargetPrefix};
if (PrefixTriple.getArch() == llvm::Triple::UnknownArch ||
PrefixTriple.isOSUnknown())
- Triple = PrefixTriple.str();
+ Triple = PrefixTriple;
}
// Otherwise, use the real triple as used by the driver.
- if (Triple.empty()) {
- llvm::Triple RealTriple =
- computeTargetTriple(*this, TargetTriple, *CLOptions);
- Triple = RealTriple.str();
- assert(!Triple.empty());
+ if (Triple.str().empty()) {
+ Triple = computeTargetTriple(*this, TargetTriple, *CLOptions);
+ assert(!Triple.str().empty());
}
// Search for config files in the following order:
@@ -1192,21 +1218,21 @@ bool Driver::loadDefaultConfigFiles(llvm::cl::ExpansionContext &ExpCtx) {
// Try loading <triple>-<mode>.cfg, and return if we find a match.
SmallString<128> CfgFilePath;
- std::string CfgFileName = Triple + '-' + RealMode + ".cfg";
- if (ExpCtx.findConfigFile(CfgFileName, CfgFilePath))
+ if (findTripleConfigFile(ExpCtx, CfgFilePath, Triple,
+ "-" + RealMode + ".cfg"))
return readConfigFile(CfgFilePath, ExpCtx);
bool TryModeSuffix = !ClangNameParts.ModeSuffix.empty() &&
ClangNameParts.ModeSuffix != RealMode;
if (TryModeSuffix) {
- CfgFileName = Triple + '-' + ClangNameParts.ModeSuffix + ".cfg";
- if (ExpCtx.findConfigFile(CfgFileName, CfgFilePath))
+ if (findTripleConfigFile(ExpCtx, CfgFilePath, Triple,
+ "-" + ClangNameParts.ModeSuffix + ".cfg"))
return readConfigFile(CfgFilePath, ExpCtx);
}
// Try loading <mode>.cfg, and return if loading failed. If a matching file
// was not found, still proceed on to try <triple>.cfg.
- CfgFileName = RealMode + ".cfg";
+ std::string CfgFileName = RealMode + ".cfg";
if (ExpCtx.findConfigFile(CfgFileName, CfgFilePath)) {
if (readConfigFile(CfgFilePath, ExpCtx))
return true;
@@ -1218,8 +1244,7 @@ bool Driver::loadDefaultConfigFiles(llvm::cl::ExpansionContext &ExpCtx) {
}
// Try loading <triple>.cfg and return if we find a match.
- CfgFileName = Triple + ".cfg";
- if (ExpCtx.findConfigFile(CfgFileName, CfgFilePath))
+ if (findTripleConfigFile(ExpCtx, CfgFilePath, Triple, ".cfg"))
return readConfigFile(CfgFilePath, ExpCtx);
// If we were unable to find a config file deduced from executable name,
diff --git a/clang/test/Driver/config-file3.c b/clang/test/Driver/config-file3.c
index a0b8062c60ce52..395c31ce04b6b8 100644
--- a/clang/test/Driver/config-file3.c
+++ b/clang/test/Driver/config-file3.c
@@ -226,3 +226,26 @@
//
// RUN: HOME=%S/Inputs/config %clang -### --config-user-dir=~ -v 2>&1 | FileCheck %s --check-prefix=CHECK-TILDE
// CHECK-TILDE: User configuration file directory: {{.*}}/Inputs/config
+
+//--- Fallback to stripping OS versions
+//
+// RUN: touch %t/testdmode/x86_64-apple-darwin23.6.0-clang.cfg
+// RUN: touch %t/testdmode/x86_64-apple-darwin23-clang.cfg
+// RUN: touch %t/testdmode/x86_64-apple-darwin-clang.cfg
+// RUN: %clang -target x86_64-apple-darwin23.6.0 --config-system-dir=%t/testdmode --config-user-dir= -no-canonical-prefixes --version 2>&1 | FileCheck %s -check-prefix DARWIN --implicit-check-not 'Configuration file:'
+//
+// DARWIN: Configuration file: {{.*}}/testdmode/x86_64-apple-darwin23.6.0-clang.cfg
+
+//--- DARWIN + no full version
+//
+// RUN: rm %t/testdmode/x86_64-apple-darwin23.6.0-clang.cfg
+// RUN: %clang -target x86_64-apple-darwin23.6.0 --config-system-dir=%t/testdmode --config-user-dir= -no-canonical-prefixes --version 2>&1 | FileCheck %s -check-prefix DARWIN-MAJOR --implicit-check-not 'Configuration file:'
+//
+// DARWIN-MAJOR: Configuration file: {{.*}}/testdmode/x86_64-apple-darwin23-clang.cfg
+
+//--- DARWIN + no version
+//
+// RUN: rm %t/testdmode/x86_64-apple-darwin23-clang.cfg
+// RUN: %clang -target x86_64-apple-darwin23.6.0 --config-system-dir=%t/testdmode --config-user-dir= -no-canonical-prefixes --version 2>&1 | FileCheck %s -check-prefix DARWIN-VERSIONLESS --implicit-check-not 'Configuration file:'
+//
+// DARWIN-VERSIONLESS: Configuration file: {{.*}}/testdmode/x86_64-apple-darwin-clang.cfg
|
|
@llvm/pr-subscribers-clang-driver Author: Bo Anderson (Bo98) ChangesCurrently, the config file system loads the full target triple, e.g. This is however not very useful as this is a moving target. In the case of macOS, that target moves every 2 months. We can improve this by adding fallbacks that simplify the version component of the triple. This pull request adds support for loading Full diff: https://github.com/llvm/llvm-project/pull/111387.diff 2 Files Affected:
diff --git a/clang/lib/Driver/Driver.cpp b/clang/lib/Driver/Driver.cpp
index a5d43bdac23735..26aa7f67842ce9 100644
--- a/clang/lib/Driver/Driver.cpp
+++ b/clang/lib/Driver/Driver.cpp
@@ -1147,6 +1147,34 @@ bool Driver::loadConfigFiles() {
return false;
}
+static bool findTripleConfigFile(llvm::cl::ExpansionContext &ExpCtx,
+ SmallString<128> &ConfigFilePath,
+ llvm::Triple Triple, std::string Suffix) {
+ // First, try the full unmodified triple.
+ if (ExpCtx.findConfigFile(Triple.str() + Suffix, ConfigFilePath))
+ return true;
+
+ // Don't continue if we didn't find a parsable version in the triple.
+ VersionTuple OSVersion = Triple.getOSVersion();
+ if (!OSVersion.getMinor().has_value())
+ return false;
+
+ std::string BaseOSName = Triple.getOSTypeName(Triple.getOS()).str();
+
+ // Next try strip the version to only include the major component.
+ // e.g. arm64-apple-darwin23.6.0 -> arm64-apple-darwin23
+ if (OSVersion.getMajor() != 0) {
+ Triple.setOSName(BaseOSName + llvm::utostr(OSVersion.getMajor()));
+ if (ExpCtx.findConfigFile(Triple.str() + Suffix, ConfigFilePath))
+ return true;
+ }
+
+ // Finally, try without any version suffix at all.
+ // e.g. arm64-apple-darwin23.6.0 -> arm64-apple-darwin
+ Triple.setOSName(BaseOSName);
+ return ExpCtx.findConfigFile(Triple.str() + Suffix, ConfigFilePath);
+}
+
bool Driver::loadDefaultConfigFiles(llvm::cl::ExpansionContext &ExpCtx) {
// Disable default config if CLANG_NO_DEFAULT_CONFIG is set to a non-empty
// value.
@@ -1158,7 +1186,7 @@ bool Driver::loadDefaultConfigFiles(llvm::cl::ExpansionContext &ExpCtx) {
return false;
std::string RealMode = getExecutableForDriverMode(Mode);
- std::string Triple;
+ llvm::Triple Triple;
// If name prefix is present, no --target= override was passed via CLOptions
// and the name prefix is not a valid triple, force it for backwards
@@ -1169,15 +1197,13 @@ bool Driver::loadDefaultConfigFiles(llvm::cl::ExpansionContext &ExpCtx) {
llvm::Triple PrefixTriple{ClangNameParts.TargetPrefix};
if (PrefixTriple.getArch() == llvm::Triple::UnknownArch ||
PrefixTriple.isOSUnknown())
- Triple = PrefixTriple.str();
+ Triple = PrefixTriple;
}
// Otherwise, use the real triple as used by the driver.
- if (Triple.empty()) {
- llvm::Triple RealTriple =
- computeTargetTriple(*this, TargetTriple, *CLOptions);
- Triple = RealTriple.str();
- assert(!Triple.empty());
+ if (Triple.str().empty()) {
+ Triple = computeTargetTriple(*this, TargetTriple, *CLOptions);
+ assert(!Triple.str().empty());
}
// Search for config files in the following order:
@@ -1192,21 +1218,21 @@ bool Driver::loadDefaultConfigFiles(llvm::cl::ExpansionContext &ExpCtx) {
// Try loading <triple>-<mode>.cfg, and return if we find a match.
SmallString<128> CfgFilePath;
- std::string CfgFileName = Triple + '-' + RealMode + ".cfg";
- if (ExpCtx.findConfigFile(CfgFileName, CfgFilePath))
+ if (findTripleConfigFile(ExpCtx, CfgFilePath, Triple,
+ "-" + RealMode + ".cfg"))
return readConfigFile(CfgFilePath, ExpCtx);
bool TryModeSuffix = !ClangNameParts.ModeSuffix.empty() &&
ClangNameParts.ModeSuffix != RealMode;
if (TryModeSuffix) {
- CfgFileName = Triple + '-' + ClangNameParts.ModeSuffix + ".cfg";
- if (ExpCtx.findConfigFile(CfgFileName, CfgFilePath))
+ if (findTripleConfigFile(ExpCtx, CfgFilePath, Triple,
+ "-" + ClangNameParts.ModeSuffix + ".cfg"))
return readConfigFile(CfgFilePath, ExpCtx);
}
// Try loading <mode>.cfg, and return if loading failed. If a matching file
// was not found, still proceed on to try <triple>.cfg.
- CfgFileName = RealMode + ".cfg";
+ std::string CfgFileName = RealMode + ".cfg";
if (ExpCtx.findConfigFile(CfgFileName, CfgFilePath)) {
if (readConfigFile(CfgFilePath, ExpCtx))
return true;
@@ -1218,8 +1244,7 @@ bool Driver::loadDefaultConfigFiles(llvm::cl::ExpansionContext &ExpCtx) {
}
// Try loading <triple>.cfg and return if we find a match.
- CfgFileName = Triple + ".cfg";
- if (ExpCtx.findConfigFile(CfgFileName, CfgFilePath))
+ if (findTripleConfigFile(ExpCtx, CfgFilePath, Triple, ".cfg"))
return readConfigFile(CfgFilePath, ExpCtx);
// If we were unable to find a config file deduced from executable name,
diff --git a/clang/test/Driver/config-file3.c b/clang/test/Driver/config-file3.c
index a0b8062c60ce52..395c31ce04b6b8 100644
--- a/clang/test/Driver/config-file3.c
+++ b/clang/test/Driver/config-file3.c
@@ -226,3 +226,26 @@
//
// RUN: HOME=%S/Inputs/config %clang -### --config-user-dir=~ -v 2>&1 | FileCheck %s --check-prefix=CHECK-TILDE
// CHECK-TILDE: User configuration file directory: {{.*}}/Inputs/config
+
+//--- Fallback to stripping OS versions
+//
+// RUN: touch %t/testdmode/x86_64-apple-darwin23.6.0-clang.cfg
+// RUN: touch %t/testdmode/x86_64-apple-darwin23-clang.cfg
+// RUN: touch %t/testdmode/x86_64-apple-darwin-clang.cfg
+// RUN: %clang -target x86_64-apple-darwin23.6.0 --config-system-dir=%t/testdmode --config-user-dir= -no-canonical-prefixes --version 2>&1 | FileCheck %s -check-prefix DARWIN --implicit-check-not 'Configuration file:'
+//
+// DARWIN: Configuration file: {{.*}}/testdmode/x86_64-apple-darwin23.6.0-clang.cfg
+
+//--- DARWIN + no full version
+//
+// RUN: rm %t/testdmode/x86_64-apple-darwin23.6.0-clang.cfg
+// RUN: %clang -target x86_64-apple-darwin23.6.0 --config-system-dir=%t/testdmode --config-user-dir= -no-canonical-prefixes --version 2>&1 | FileCheck %s -check-prefix DARWIN-MAJOR --implicit-check-not 'Configuration file:'
+//
+// DARWIN-MAJOR: Configuration file: {{.*}}/testdmode/x86_64-apple-darwin23-clang.cfg
+
+//--- DARWIN + no version
+//
+// RUN: rm %t/testdmode/x86_64-apple-darwin23-clang.cfg
+// RUN: %clang -target x86_64-apple-darwin23.6.0 --config-system-dir=%t/testdmode --config-user-dir= -no-canonical-prefixes --version 2>&1 | FileCheck %s -check-prefix DARWIN-VERSIONLESS --implicit-check-not 'Configuration file:'
+//
+// DARWIN-VERSIONLESS: Configuration file: {{.*}}/testdmode/x86_64-apple-darwin-clang.cfg
|
|
Ping? |
4 tasks
carlocab
requested review from
mgorny,
MaskRay,
jyknight,
AaronBallman and
cachemeifyoucan
MaskRay
reviewed
Dec 6, 2024
| // RUN: touch %t/testdmode/x86_64-apple-darwin23.6.0-clang.cfg | ||
| // RUN: touch %t/testdmode/x86_64-apple-darwin23-clang.cfg | ||
| // RUN: touch %t/testdmode/x86_64-apple-darwin-clang.cfg | ||
| // RUN: %clang -target x86_64-apple-darwin23.6.0 --config-system-dir=%t/testdmode --config-user-dir= -no-canonical-prefixes --version 2>&1 | FileCheck %s -check-prefix DARWIN --implicit-check-not 'Configuration file:' |
There was a problem hiding this comment.
Prefer --target=. -target has been deprecated for a long time.
No need to have ^//$ lines.
There was a problem hiding this comment.
It actually spells -target for Darwin.
There was a problem hiding this comment.
No need to have
^//$lines.
The whole file already has it, so this is just matching the style. Is the preferred approach to match the file's style or to use the newer style for new tests (and maybe go back an update old tests in a cleanup PR at some point)?
MaskRay
approved these changes
Dec 6, 2024
|
Merging this to land the improvement. Happy to work on suggested improvements for the tests if any are still outstanding from the discussion in #111387 (comment) (since it's not clear to me which comments still apply). CC @MaskRay |
|
@Bo98 Congratulations on having your first Pull Request (PR) merged into the LLVM Project! Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR. Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues. How to do this, and the rest of the post-merge process, is covered in detail here. If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again. If you don't get any reports, no action is required from you. Your changes are working as expected, well done! |
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/73/builds/10156 Here is the relevant piece of the build log for the reference |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, the config file system loads the full target triple, e.g.
arm64-apple-darwin23.6.0.cfg.This is however not very useful as this is a moving target. In the case of macOS, that target moves every ~2 months.
We can improve this by adding fallbacks that simplify the version component of the triple. This pull request adds support for loading
arm64-apple-darwin23.cfgandarm64-apple-darwin.cfg. See the included test for a demonstration on how it works.