Skip to content

[clang][Darwin] Remove legacy framework search path logic in the frontend #120149

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

Closed
wants to merge 8 commits into from
Closed

[clang][Darwin] Remove legacy framework search path logic in the frontend #120149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ac16507
[clang][Darwin] Remove legacy framework search path logic in the fron…
ldionne Dec 16, 2024
561eb31
Remove CUDA on Mac test since that isn't supported anymore
ldionne Dec 19, 2024
330d2e0
Use macosx15.1 target instead of darwin13.0
ldionne Dec 19, 2024
7cd2067
Add SubFrameworks to Driverkit path test
ldionne Jan 7, 2025
4187453
Make AddFrameworkInclude take same args as AddSearchPath
ldionne Jan 7, 2025
2f01df2
Use -### style tests
ldionne Jan 7, 2025
926996e
Add missing argument generation
ldionne Jan 7, 2025
e624fd8
TEST: Try removing -internal-iframework to see the consequences. I wo…
ldionne Jan 7, 2025
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
4 changes: 2 additions & 2 deletions clang/include/clang/Driver/Options.td
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3218,7 +3218,7 @@ def modules_reduced_bmi : Flag<["-"], "fmodules-reduced-bmi">,
HelpText<"Generate the reduced BMI">,
MarshallingInfoFlag<FrontendOpts<"GenReducedBMI">>;

def experimental_modules_reduced_bmi : Flag<["-"], "fexperimental-modules-reduced-bmi">,
def experimental_modules_reduced_bmi : Flag<["-"], "fexperimental-modules-reduced-bmi">,
Group<f_Group>, Visibility<[ClangOption, CC1Option]>, Alias<modules_reduced_bmi>;

def fmodules_embed_all_files : Joined<["-"], "fmodules-embed-all-files">,
Expand Down Expand Up @@ -7421,7 +7421,7 @@ def fuse_register_sized_bitfield_access: Flag<["-"], "fuse-register-sized-bitfie
def relaxed_aliasing : Flag<["-"], "relaxed-aliasing">,
HelpText<"Turn off Type Based Alias Analysis">,
MarshallingInfoFlag<CodeGenOpts<"RelaxedAliasing">>;
defm pointer_tbaa: BoolOption<"", "pointer-tbaa", CodeGenOpts<"PointerTBAA">,
defm pointer_tbaa: BoolOption<"", "pointer-tbaa", CodeGenOpts<"PointerTBAA">,
DefaultTrue,
PosFlag<SetTrue, [], [ClangOption], "Enable">,
NegFlag<SetFalse, [], [ClangOption], "Disable">,
Expand Down
48 changes: 35 additions & 13 deletions clang/lib/Driver/ToolChains/Darwin.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -800,9 +800,15 @@ void darwin::Linker::ConstructJob(Compilation &C, const JobAction &JA,
}
}

// Add non-standard, platform-specific search paths, e.g., for DriverKit:
// -L<sysroot>/System/DriverKit/usr/lib
// -F<sysroot>/System/DriverKit/System/Library/Framework
// Add framework include paths and library search paths.
// There are two flavors:
// 1. The "non-standard" paths, e.g. for DriverKit:
// -L<sysroot>/System/DriverKit/usr/lib
// -F<sysroot>/System/DriverKit/System/Library/Frameworks
// 2. The "standard" paths, e.g. for macOS and iOS:
// -F<sysroot>/System/Library/Frameworks
// -F<sysroot>/System/Library/SubFrameworks
// -F<sysroot>/Library/Frameworks
{
bool NonStandardSearchPath = false;
const auto &Triple = getToolChain().getTriple();
Expand All @@ -813,18 +819,23 @@ void darwin::Linker::ConstructJob(Compilation &C, const JobAction &JA,
(Version.getMajor() == 605 && Version.getMinor().value_or(0) < 1);
}

if (NonStandardSearchPath) {
if (auto *Sysroot = Args.getLastArg(options::OPT_isysroot)) {
auto AddSearchPath = [&](StringRef Flag, StringRef SearchPath) {
SmallString<128> P(Sysroot->getValue());
AppendPlatformPrefix(P, Triple);
llvm::sys::path::append(P, SearchPath);
if (getToolChain().getVFS().exists(P)) {
CmdArgs.push_back(Args.MakeArgString(Flag + P));
}
};
if (auto *Sysroot = Args.getLastArg(options::OPT_isysroot)) {
auto AddSearchPath = [&](StringRef Flag, StringRef SearchPath) {
SmallString<128> P(Sysroot->getValue());
AppendPlatformPrefix(P, Triple);
llvm::sys::path::append(P, SearchPath);
if (getToolChain().getVFS().exists(P)) {
CmdArgs.push_back(Args.MakeArgString(Flag + P));
}
};

if (NonStandardSearchPath) {
AddSearchPath("-L", "/usr/lib");
AddSearchPath("-F", "/System/Library/Frameworks");
} else if (!Triple.isDriverKit()) {
AddSearchPath("-F", "/System/Library/Frameworks");
AddSearchPath("-F", "/System/Library/SubFrameworks");
AddSearchPath("-F", "/Library/Frameworks");
}
}
}
Expand Down Expand Up @@ -2547,6 +2558,17 @@ void DarwinClang::AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs
llvm::sys::path::append(P, "usr", "include");
addExternCSystemInclude(DriverArgs, CC1Args, P.str());
}

// Add default framework search paths
auto AddFrameworkInclude = [&](StringRef Flag, StringRef SearchPath) {
SmallString<128> P(Sysroot);
llvm::sys::path::append(P, SearchPath);
CC1Args.push_back(DriverArgs.MakeArgString(Flag));
CC1Args.push_back(DriverArgs.MakeArgString(P));
};
AddFrameworkInclude("-iframework", "/System/Library/Frameworks");
AddFrameworkInclude("-iframework", "/System/Library/SubFrameworks");
AddFrameworkInclude("-iframework", "/Library/Frameworks");
}

bool DarwinClang::AddGnuCPlusPlusIncludePaths(const llvm::opt::ArgList &DriverArgs,
Expand Down
19 changes: 3 additions & 16 deletions clang/lib/Lex/InitHeaderSearch.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,9 @@ bool InitHeaderSearch::ShouldAddDefaultIncludePaths(
break;
}

if (triple.isOSDarwin())
return false;

return true; // Everything else uses AddDefaultIncludePaths().
}

Expand All @@ -335,22 +338,6 @@ void InitHeaderSearch::AddDefaultIncludePaths(
if (!ShouldAddDefaultIncludePaths(triple))
return;

// NOTE: some additional header search logic is handled in the driver for
// Darwin.
if (triple.isOSDarwin()) {
if (HSOpts.UseStandardSystemIncludes) {
// Add the default framework include paths on Darwin.
if (triple.isDriverKit()) {
AddPath("/System/DriverKit/System/Library/Frameworks", System, true);
} else {
AddPath("/System/Library/Frameworks", System, true);
AddPath("/System/Library/SubFrameworks", System, true);
AddPath("/Library/Frameworks", System, true);
}
}
return;
}

if (Lang.CPlusPlus && !Lang.AsmPreprocessor &&
HSOpts.UseStandardCXXIncludes && HSOpts.UseStandardSystemIncludes) {
if (HSOpts.UseLibcxx) {
Expand Down
Empty file added .../test/Driver/Inputs/DriverKit19.0.sdk/System/DriverKit/System/Library/SubFrameworks/.keep
View file
Open in desktop
Empty file.
26 changes: 26 additions & 0 deletions clang/test/Driver/darwin-framework-search-paths.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// UNSUPPORTED: system-windows
// Windows is unsupported because we use the Unix path separator `/` in the test.

// Add default directories before running clang to check default
// search paths.
// RUN: rm -rf %t && mkdir -p %t
// RUN: cp -R %S/Inputs/MacOSX15.1.sdk %t/
// RUN: mkdir -p %t/MacOSX15.1.sdk/System/Library/Frameworks
// RUN: mkdir -p %t/MacOSX15.1.sdk/System/Library/SubFrameworks
// RUN: mkdir -p %t/MacOSX15.1.sdk/usr/include

// RUN: %clang -xc %s -target arm64-apple-macosx15.1 -isysroot %t/MacOSX15.1.sdk -c -### 2>&1 \
// RUN: | FileCheck -DSDKROOT=%t/MacOSX15.1.sdk --check-prefix=CHECK-C %s
//
// CHECK-C: "-isysroot" "[[SDKROOT]]"
// CHECK-C: "-internal-externc-isystem" "[[SDKROOT]]/usr/include"
// CHECK-C: "-iframework" "[[SDKROOT]]/System/Library/Frameworks"
// CHECK-C: "-iframework" "[[SDKROOT]]/System/Library/SubFrameworks"

// RUN: %clang -xc++ %s -target arm64-apple-macosx15.1 -isysroot %t/MacOSX15.1.sdk -c -### 2>&1 \
// RUN: | FileCheck -DSDKROOT=%t/MacOSX15.1.sdk --check-prefix=CHECK-CXX %s
//
// CHECK-CXX: "-isysroot" "[[SDKROOT]]"
// CHECK-CXX: "-internal-externc-isystem" "[[SDKROOT]]/usr/include"
// CHECK-CXX: "-iframework" "[[SDKROOT]]/System/Library/Frameworks"
// CHECK-CXX: "-iframework" "[[SDKROOT]]/System/Library/SubFrameworks"
18 changes: 0 additions & 18 deletions clang/test/Driver/darwin-subframeworks.c
View file
Open in desktop

This file was deleted.

16 changes: 9 additions & 7 deletions clang/test/Driver/driverkit-path.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,15 @@ int main() { return 0; }
// LD64-NEW: "-isysroot" "[[PATH:[^"]*]]Inputs/DriverKit19.0.sdk"
// LD64-NEW-NOT: "-L[[PATH]]Inputs/DriverKit19.0.sdk/System/DriverKit/usr/lib"
// LD64-NEW-NOT: "-F[[PATH]]Inputs/DriverKit19.0.sdk/System/DriverKit/System/Library/Frameworks"
// LD64-NEW-NOT: "-F[[PATH]]Inputs/DriverKit19.0.sdk/System/DriverKit/System/Library/SubFrameworks"


// RUN: %clang %s -target x86_64-apple-driverkit19.0 -isysroot %S/Inputs/DriverKit19.0.sdk -E -v -x c++ 2>&1 | FileCheck %s --check-prefix=INC
// RUN: %clang %s -target x86_64-apple-driverkit19.0 -isysroot %S/Inputs/DriverKit19.0.sdk -x c++ -### 2>&1 \
// RUN: | FileCheck %s -DSDKROOT=%S/Inputs/DriverKit19.0.sdk --check-prefix=INC
//
// INC: -isysroot [[PATH:[^ ]*/Inputs/DriverKit19.0.sdk]]
// INC-LABEL: #include <...> search starts here:
// INC: [[PATH]]/System/DriverKit/usr/local/include
// INC: /lib{{(64)?}}/clang/{{[^/ ]+}}/include
// INC: [[PATH]]/System/DriverKit/usr/include
// INC: [[PATH]]/System/DriverKit/System/Library/Frameworks (framework directory)
// INC: "-isysroot" "[[SDKROOT]]"
// INC: "-internal-isystem" "[[SDKROOT]]/System/DriverKit/usr/local/include"
// INC: "-internal-isystem" "{{.+}}/lib{{(64)?}}/clang/{{[^/ ]+}}/include"
// INC: "-internal-externc-isystem" "[[SDKROOT]]/System/DriverKit/usr/include"
// INC: "-iframework" "[[SDKROOT]]/System/DriverKit/System/Library/Frameworks"
// INC: "-iframework" "[[SDKROOT]]/System/DriverKit/System/Library/SubFrameworks"
13 changes: 0 additions & 13 deletions clang/test/Preprocessor/cuda-macos-includes.cu
View file
Open in desktop

This file was deleted.

Loading