Skip to content

[Macros] Add executable plugin support #63793

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
rintaro merged 7 commits into from
Feb 23, 2023
Merged

[Macros] Add executable plugin support #63793

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0e31393
[Macros] Add executable plugin support
rintaro Feb 16, 2023
e840409
[ASTGen] Remove unnecessary parameters from the expansion funcs
rintaro Feb 22, 2023
396c227
[CASTBridging] Typedefs for opaque pointer types
rintaro Feb 23, 2023
c5a737f
[AST] PluginRegistry returns Error/Expected instead of errorMsg out
rintaro Feb 23, 2023
c6387a5
[Macros] Small changes for review
rintaro Feb 23, 2023
623043e
[AST] Fix Windows compile error
rintaro Feb 23, 2023
138934e
[PluginRegistry] Error handling tweaks
rintaro Feb 23, 2023
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
11 changes: 6 additions & 5 deletions include/swift/AST/PluginRegistry.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
#include "llvm/ADT/StringMap.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Chrono.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/Program.h"

#include <mutex>
Expand Down Expand Up @@ -52,10 +53,10 @@ class LoadedExecutablePlugin {
void unlock() { mtx.unlock(); }

/// Send a message to the plugin.
bool sendMessage(llvm::StringRef message) const;
llvm::Error sendMessage(llvm::StringRef message) const;

/// Wait for a message from plugin and returns it.
std::string waitForNextMessage() const;
llvm::Expected<std::string> waitForNextMessage() const;

bool isInitialized() const { return bool(cleanup); }
void setCleanup(std::function<void(void)> cleanup) {
Expand All @@ -77,9 +78,9 @@ class PluginRegistry {
LoadedPluginExecutables;

public:
bool loadLibraryPlugin(llvm::StringRef path, const char *&errorMsg);
LoadedExecutablePlugin *loadExecutablePlugin(llvm::StringRef path,
const char *&errorMsg);
llvm::Error loadLibraryPlugin(llvm::StringRef path);
llvm::Expected<LoadedExecutablePlugin *>
loadExecutablePlugin(llvm::StringRef path);

const llvm::StringMap<void *> &getLoadedLibraryPlugins() const {
return LoadedPluginLibraries;
Expand Down
12 changes: 5 additions & 7 deletions lib/AST/ASTContext.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6227,7 +6227,6 @@ PluginRegistry *ASTContext::getPluginRegistry() const {
}

void ASTContext::loadCompilerPlugins() {
const char *errorMsg = nullptr;
auto fs = this->SourceMgr.getFileSystem();
for (auto &path : SearchPathOpts.getCompilerPluginLibraryPaths()) {
SmallString<128> resolvedPath;
Expand All @@ -6236,9 +6235,9 @@ void ASTContext::loadCompilerPlugins() {
err.message());
continue;
}
if (getPluginRegistry()->loadLibraryPlugin(resolvedPath, errorMsg)) {
if (auto error = getPluginRegistry()->loadLibraryPlugin(resolvedPath)) {
Diags.diagnose(SourceLoc(), diag::compiler_plugin_not_loaded, path,
errorMsg);
llvm::toString(std::move(error)));
}
}

Expand Down Expand Up @@ -6339,12 +6338,11 @@ ASTContext::lookupExecutablePluginByModuleName(Identifier moduleName) {
}

// Load the plugin.
const char *errorMsg;
auto plugin = getPluginRegistry()->loadExecutablePlugin(resolvedPath, errorMsg);
auto plugin = getPluginRegistry()->loadExecutablePlugin(resolvedPath);
if (!plugin) {
Diags.diagnose(SourceLoc(), diag::compiler_plugin_not_loaded, path,
errorMsg);
llvm::toString(plugin.takeError()));
}

return plugin;
return plugin.get();
}
13 changes: 9 additions & 4 deletions lib/AST/CASTBridging.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -651,14 +651,19 @@ void Plugin_unlock(PluginHandle handle) {
bool Plugin_sendMessage(PluginHandle handle, const BridgedData data) {
auto *plugin = static_cast<LoadedExecutablePlugin *>(handle);
StringRef message(data.baseAddress, data.size);
return plugin->sendMessage(message);
return bool(plugin->sendMessage(message));
Copy link
Contributor

@bnbarham bnbarham Feb 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fairly sure this will still fail when there's an error. LLVM has a consumeError to just eat it, though that makes me wonder if we should be passing in an error string to set.

}

bool Plugin_waitForNextMessage(PluginHandle handle, BridgedData *out) {
auto *plugin = static_cast<LoadedExecutablePlugin *>(handle);
auto result = plugin->waitForNextMessage();
auto outPtr = malloc(result.size());
memcpy(outPtr, result.data(), result.size());
*out = BridgedData{(const char *)outPtr, result.size()};
if (!result) {
return true;
}
auto &message = result.get();
auto size = message.size();
auto outPtr = malloc(size);
memcpy(outPtr, message.data(), size);
*out = BridgedData{(const char *)outPtr, size};
return false;
}
36 changes: 17 additions & 19 deletions lib/AST/PluginRegistry.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,35 +41,34 @@ extern "C" void swift_ASTGen_destroyCompilerPluginCapability(void *value);

using namespace swift;

bool PluginRegistry::loadLibraryPlugin(StringRef path, const char *&errorMsg) {
llvm::Error PluginRegistry::loadLibraryPlugin(StringRef path) {
if (LoadedPluginLibraries.find(path) != LoadedPluginLibraries.end()) {
// Already loaded.
return false;
return llvm::Error::success();
}
errorMsg = nullptr;
void *lib = nullptr;
#if defined(_WIN32)
lib = LoadLibraryA(path.str().c_str());
if (!lib) {
errorMsg = "faild";
return llvm::createStringError(std::errc::not_supported, "failed");
return true;
}
#else
lib = dlopen(path.str().c_str(), RTLD_LAZY | RTLD_LOCAL);
if (!lib) {
errorMsg = "Unsupported platform";
return true;
return llvm::createStringError(std::errc::not_supported,
"unsupported platform");
}
#endif
LoadedPluginLibraries.insert({path, lib});
return false;
return llvm::Error::success();
}

LoadedExecutablePlugin *
PluginRegistry::loadExecutablePlugin(StringRef path, const char *&errorMsg) {
llvm::Expected<LoadedExecutablePlugin *>
PluginRegistry::loadExecutablePlugin(StringRef path) {
llvm::sys::fs::file_status stat;
if (auto err = llvm::sys::fs::status(path, stat)) {
errorMsg = err.message().c_str();
return llvm::errorCodeToError(err);
}

// See if the plugin is already loaded.
Expand All @@ -84,13 +83,13 @@ PluginRegistry::loadExecutablePlugin(StringRef path, const char *&errorMsg) {
}

if (!llvm::sys::fs::exists(stat)) {
errorMsg = "not found";
return nullptr;
return llvm::createStringError(std::errc::no_such_file_or_directory,
"not found");
}

if (!llvm::sys::fs::can_execute(path)) {
errorMsg = "not executable";
return nullptr;
return llvm::createStringError(std::errc::permission_denied,
"not executable");
}

// Create command line arguments.
Expand All @@ -103,8 +102,7 @@ PluginRegistry::loadExecutablePlugin(StringRef path, const char *&errorMsg) {
// Launch.
auto childInfo = ExecuteWithPipe(command[0], command);
if (!childInfo) {
errorMsg = "Failed to execute";
return nullptr;
return llvm::errorCodeToError(childInfo.getError());
}

plugin = std::unique_ptr<LoadedExecutablePlugin>(new LoadedExecutablePlugin(
Expand Down Expand Up @@ -163,7 +161,7 @@ ssize_t LoadedExecutablePlugin::write(const void *buf, size_t nbyte) const {
return nbyte - bytesToWrite;
}

bool LoadedExecutablePlugin::sendMessage(llvm::StringRef message) const {
llvm::Error LoadedExecutablePlugin::sendMessage(llvm::StringRef message) const {
ssize_t writtenSize = 0;

const char *data = message.data();
Expand All @@ -180,10 +178,10 @@ bool LoadedExecutablePlugin::sendMessage(llvm::StringRef message) const {
writtenSize = write(data, size);
assert(writtenSize == ssize_t(size) && "failed to write plugin message data");

return false;
return llvm::Error::success();
}

std::string LoadedExecutablePlugin::waitForNextMessage() const {
llvm::Expected<std::string> LoadedExecutablePlugin::waitForNextMessage() const {
ssize_t readSize = 0;

// Read header (message size).
Expand Down