113 lines
3.8 KiB
C++
113 lines
3.8 KiB
C++
//===- mlir/Tools/Plugins/PassPlugin.h - Public Plugin API ----------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This defines the public entry point for pass plugins.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef MLIR_TOOLS_PLUGINS_PASSPLUGIN_H
|
|
#define MLIR_TOOLS_PLUGINS_PASSPLUGIN_H
|
|
|
|
#include "mlir/Support/LLVM.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/Support/Compiler.h"
|
|
#include "llvm/Support/DynamicLibrary.h"
|
|
#include "llvm/Support/Error.h"
|
|
#include <cstdint>
|
|
#include <string>
|
|
|
|
namespace mlir {
|
|
/// \macro MLIR_PLUGIN_API_VERSION
|
|
/// Identifies the API version understood by this plugin.
|
|
///
|
|
/// When a plugin is loaded, the driver will check it's supported plugin version
|
|
/// against that of the plugin. A mismatch is an error. The supported version
|
|
/// will be incremented for ABI-breaking changes to the \c PassPluginLibraryInfo
|
|
/// struct, i.e. when callbacks are added, removed, or reordered.
|
|
#define MLIR_PLUGIN_API_VERSION 1
|
|
|
|
extern "C" {
|
|
/// Information about the plugin required to load its passes
|
|
///
|
|
/// This struct defines the core interface for pass plugins and is supposed to
|
|
/// be filled out by plugin implementors. LLVM-side users of a plugin are
|
|
/// expected to use the \c PassPlugin class below to interface with it.
|
|
struct PassPluginLibraryInfo {
|
|
/// The API version understood by this plugin, usually \c
|
|
/// MLIR_PLUGIN_API_VERSION
|
|
uint32_t apiVersion;
|
|
/// A meaningful name of the plugin.
|
|
const char *pluginName;
|
|
/// The version of the plugin.
|
|
const char *pluginVersion;
|
|
|
|
/// The callback for registering plugin passes.
|
|
void (*registerPassRegistryCallbacks)();
|
|
};
|
|
}
|
|
|
|
/// A loaded pass plugin.
|
|
///
|
|
/// An instance of this class wraps a loaded pass plugin and gives access to
|
|
/// its interface defined by the \c PassPluginLibraryInfo it exposes.
|
|
class PassPlugin {
|
|
public:
|
|
/// Attempts to load a pass plugin from a given file.
|
|
///
|
|
/// \returns Returns an error if either the library cannot be found or loaded,
|
|
/// there is no public entry point, or the plugin implements the wrong API
|
|
/// version.
|
|
static llvm::Expected<PassPlugin> load(const std::string &filename);
|
|
|
|
/// Get the filename of the loaded plugin.
|
|
StringRef getFilename() const { return filename; }
|
|
|
|
/// Get the plugin name
|
|
StringRef getPluginName() const { return info.pluginName; }
|
|
|
|
/// Get the plugin version
|
|
StringRef getPluginVersion() const { return info.pluginVersion; }
|
|
|
|
/// Get the plugin API version
|
|
uint32_t getAPIVersion() const { return info.apiVersion; }
|
|
|
|
/// Invoke the PassRegistry callback registration
|
|
void registerPassRegistryCallbacks() const {
|
|
info.registerPassRegistryCallbacks();
|
|
}
|
|
|
|
private:
|
|
PassPlugin(const std::string &filename,
|
|
const llvm::sys::DynamicLibrary &library)
|
|
: filename(filename), library(library), info() {}
|
|
|
|
std::string filename;
|
|
llvm::sys::DynamicLibrary library;
|
|
PassPluginLibraryInfo info;
|
|
};
|
|
} // namespace mlir
|
|
|
|
/// The public entry point for a pass plugin.
|
|
///
|
|
/// When a plugin is loaded by the driver, it will call this entry point to
|
|
/// obtain information about this plugin and about how to register its passes.
|
|
/// This function needs to be implemented by the plugin, see the example below:
|
|
///
|
|
/// ```
|
|
/// extern "C" ::mlir::PassPluginLibraryInfo LLVM_ATTRIBUTE_WEAK
|
|
/// mlirGetPassPluginInfo() {
|
|
/// return {
|
|
/// MLIR_PLUGIN_API_VERSION, "MyPlugin", "v0.1", []() { ... }
|
|
/// };
|
|
/// }
|
|
/// ```
|
|
extern "C" ::mlir::PassPluginLibraryInfo LLVM_ATTRIBUTE_WEAK
|
|
mlirGetPassPluginInfo();
|
|
|
|
#endif /* MLIR_TOOLS_PLUGINS_PASSPLUGIN_H */
|