Skip to content

[Macros] Track macro dylib path dependencies when using plugin server #70305

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

Merged
merged 1 commit into from
Dec 7, 2023
Merged

[Macros] Track macro dylib path dependencies when using plugin server #70305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions include/swift/AST/PluginLoader.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,9 @@ class PluginLoader {
/// instance is simply returned.
llvm::Expected<LoadedExecutablePlugin *>
loadExecutablePlugin(llvm::StringRef path);

/// Add the specified path to the dependency tracker if needed.
void recordDependency(StringRef path);
};

} // namespace swift
Expand Down
11 changes: 7 additions & 4 deletions lib/AST/PluginLoader.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,7 @@ PluginLoader::loadLibraryPlugin(StringRef path) {
}

// Track the dependency.
if (DepTracker)
DepTracker->addDependency(resolvedPath, /*IsSystem=*/false);
recordDependency(path);

// Load the plugin.
auto plugin = getRegistry()->loadLibraryPlugin(resolvedPath);
Expand All @@ -195,8 +194,7 @@ PluginLoader::loadExecutablePlugin(StringRef path) {
}

// Track the dependency.
if (DepTracker)
DepTracker->addDependency(resolvedPath, /*IsSystem=*/false);
recordDependency(path);

// Load the plugin.
auto plugin =
Expand All @@ -214,3 +212,8 @@ PluginLoader::loadExecutablePlugin(StringRef path) {

return plugin;
}

void PluginLoader::recordDependency(StringRef path) {
if (DepTracker)
DepTracker->addDependency(path, /*IsSystem=*/false);
}
3 changes: 3 additions & 0 deletions lib/Sema/TypeCheckMacros.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,9 @@ initializeExecutablePlugin(ASTContext &ctx,
if (auto err = fs->getRealPath(libraryPath, resolvedLibraryPath)) {
return llvm::createStringError(err, err.message());
}

ctx.getPluginLoader().recordDependency(resolvedLibraryPath);

std::string resolvedLibraryPathStr(resolvedLibraryPath);
std::string moduleNameStr(moduleName.str());

Expand Down
79 changes: 67 additions & 12 deletions test/Macros/macro_swiftdeps.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,27 @@

// RUN: %empty-directory(%t)
// RUN: %empty-directory(%t/plugin)
// RUN: %empty-directory(%t/external-plugin)
// RUN: %empty-directory(%t/lib)
// RUN: %empty-directory(%t/src)

// RUN: split-file %s %t/src

//#-- Prepare the macro shared library plugin.
//#-- Prepare the macro shared library plugin for -plugin-path.
// RUN: %host-build-swift \
// RUN: -swift-version 5 \
// RUN: -emit-library -o %t/plugin/%target-library-name(MacroDefinition) \
// RUN: -module-name MacroDefinition \
// RUN: %S/Inputs/syntax_macro_definitions.swift
// RUN: -emit-library -o %t/plugin/%target-library-name(StringifyPlugin) \
// RUN: -module-name StringifyPlugin \
// RUN: %t/src/StringifyPlugin.swift

//#-- Prepare the macro executable plugin.
//#-- Prepare the macro shared library plugin for -external-plugin-path.
// RUN: %host-build-swift \
// RUN: -swift-version 5 \
// RUN: -emit-library -o %t/external-plugin/%target-library-name(AssertPlugin) \
// RUN: -module-name AssertPlugin \
// RUN: %t/src/AssertPlugin.swift

//#-- Prepare the macro executable plugin for -load-plugin-executable.
// RUN: %swift-build-c-plugin -o %t/mock-plugin %t/src/plugin.c

//#-- Prepare the macro library.
Expand All @@ -23,6 +31,7 @@
// RUN: -emit-module -o %t/lib/MacroLib.swiftmodule \
// RUN: -module-name MacroLib \
// RUN: -plugin-path %t/plugin \
// RUN: -external-plugin-path %t/external-plugin#%swift-plugin-server \
// RUN: -load-plugin-executable %t/mock-plugin#TestPlugin \
// RUN: -primary-file %t/src/macro_library.swift \
// RUN: -emit-reference-dependencies-path %t/macro_library.swiftdeps \
Expand All @@ -35,7 +44,9 @@
// RUN: -swift-version 5 -typecheck \
// RUN: -primary-file %t/src/test.swift \
// RUN: %t/src/other.swift \
// RUN: -I %t/lib -plugin-path %t/plugin \
// RUN: -I %t/lib \
// RUN: -plugin-path %t/plugin \
// RUN: -external-plugin-path %t/external-plugin#%swift-plugin-server \
// RUN: -load-plugin-executable %t/mock-plugin#TestPlugin \
// RUN: -emit-reference-dependencies-path %t/without_macro.swiftdeps \
// RUN: -emit-dependencies-path %t/without_macro.d
Expand All @@ -48,7 +59,9 @@
// RUN: -swift-version 5 -typecheck \
// RUN: -primary-file %t/src/test.swift \
// RUN: %t/src/other.swift \
// RUN: -I %t/lib -plugin-path %t/plugin \
// RUN: -I %t/lib \
// RUN: -plugin-path %t/plugin \
// RUN: -external-plugin-path %t/external-plugin#%swift-plugin-server \
// RUN: -load-plugin-executable %t/mock-plugin#TestPlugin \
// RUN: -emit-reference-dependencies-path %t/with_macro_primary.swiftdeps \
// RUN: -emit-dependencies-path %t/with_macro_primary.d
Expand All @@ -61,21 +74,26 @@
// RUN: -swift-version 5 -typecheck \
// RUN: %t/src/test.swift \
// RUN: -primary-file %t/src/other.swift \
// RUN: -I %t/lib -plugin-path %t/plugin \
// RUN: -I %t/lib \
// RUN: -plugin-path %t/plugin \
// RUN: -external-plugin-path %t/external-plugin#%swift-plugin-server \
// RUN: -load-plugin-executable %t/mock-plugin#TestPlugin \
// RUN: -emit-reference-dependencies-path %t/with_macro_nonprimary.swiftdeps \
// RUN: -emit-dependencies-path %t/with_macro_nonprimary.d
// RUN: %{python} %S/../Inputs/process_fine_grained_swiftdeps.py %swift-dependency-tool %t/with_macro_nonprimary.swiftdeps > %t/with_macro_nonprimary.swiftdeps.processed
// RUN: %FileCheck --check-prefix WITHOUT_PLUGIN %s < %t/with_macro_nonprimary.swiftdeps.processed

// WITH_PLUGIN: externalDepend interface '' '{{.*}}mock-plugin' false
// WITH_PLUGIN: externalDepend interface '' '{{.*}}MacroDefinition.{{(dylib|so|dll)}}' false
// WITH_PLUGIN-DAG: externalDepend interface '' '{{.*}}mock-plugin' false
// WITH_PLUGIN-DAG: externalDepend interface '' '{{.*}}StringifyPlugin.{{(dylib|so|dll)}}' false
// WITH_PLUGIN-DAG: externalDepend interface '' '{{.*}}AssertPlugin.{{(dylib|so|dll)}}' false

// WITHOUT_PLUGIN-NOT: MacroDefinition
// WITHOUT_PLUGIN-NOT: StringifyPlugin
// WITHOUT_PLUGIN-NOT: AssertPlugin
// WITHOUT_PLUGIN-NOT: mock-plugin

//--- macro_library.swift
@freestanding(expression) public macro stringify<T>(_ value: T) -> (T, String) = #externalMacro(module: "MacroDefinition", type: "StringifyMacro")
@freestanding(expression) public macro stringify<T>(_ value: T) -> (T, String) = #externalMacro(module: "StringifyPlugin", type: "StringifyMacro")
@freestanding(expression) public macro assert(_ value: Bool) = #externalMacro(module: "AssertPlugin", type: "AssertMacro")
@freestanding(expression) public macro testString(_: Any) -> String = #externalMacro(module: "TestPlugin", type: "TestStringMacro")

public func funcInMacroLib() {}
Expand All @@ -90,6 +108,7 @@ func test(a: Int, b: Int) {
#if USE_MACRO
_ = #stringify(a + b)
_ = #testString(123)
#assert(true)
#endif
}

Expand All @@ -101,6 +120,42 @@ func test() {
funcInMacroLib()
}

//--- StringifyPlugin.swift
import SwiftSyntax
import SwiftSyntaxBuilder
import SwiftSyntaxMacros

public struct StringifyMacro: ExpressionMacro {
public static func expansion(
of macro: some FreestandingMacroExpansionSyntax,
in context: some MacroExpansionContext
) -> ExprSyntax {
guard let argument = macro.arguments.first?.expression else {
fatalError("boom")
}

return "(\(argument), \(StringLiteralExprSyntax(content: argument.description)))"
}
}

//--- AssertPlugin.swift
import SwiftSyntax
import SwiftSyntaxBuilder
import SwiftSyntaxMacros

public struct AssertMacro: ExpressionMacro {
public static func expansion(
of macro: some FreestandingMacroExpansionSyntax,
in context: some MacroExpansionContext
) -> ExprSyntax {
guard let argument = macro.arguments.first?.expression else {
fatalError("boom")
}

return "assert(\(argument))"
}
}

//--- plugin.c
#include "swift-c/MockPlugin/MockPlugin.h"

Expand Down