llvm-plugin-rs

此 crate 通过利用 Inkwell 提供的强类型接口，使您能够安全地实现针对新 LLVM 插件管理器的 passes。

如果您以前从未开发过 LLVM passes，您可以查看可用的 示例。它们（希望）会给您一个更好的了解如何使用此 crate。

如果您想深入了解围绕新 LLVM 插件管理器的许多概念，您应该阅读官方 LLVM 文档。

用法

当在您的 Cargo.toml 中导入此 crate 时，您需要指定要使用的 LLVM 版本以及相应的功能标志

[dependencies]
llvm-plugin = { version = "0.6", features = ["llvm18-0"] }

支持版本：LLVM 10-18，对应于 cargo 功能标志 llvm*-0，其中 * 对应于 LLVM 的主要版本。

入门

LLVM 插件只是一个由 LLVM 工具（例如 opt、lld）加载时提供 PassBuilder 的 dylib。因此，您必须在您的 Cargo.toml 中添加以下行

[lib]
crate-type = ["cdylib"]

PassBuilder 允许在 LLVM 工具执行特定操作时注册回调。

例如，opt 命令的 --passes 参数允许指定在给定的 IR 模块上运行的定制 pass 管道。因此，插件可以注册一个回调来解析给定管道的一个元素（例如，pass 名称），以便通过 opt 插入一个自定义的 pass。

以下代码说明了这个想法

use llvm_plugin::inkwell::module::Module;
use llvm_plugin::{
    LlvmModulePass, ModuleAnalysisManager, PassBuilder, PipelineParsing, PreservedAnalyses,
};

// A name and version is required.
#[llvm_plugin::plugin(name = "plugin_name", version = "0.1")]
fn plugin_registrar(builder: &mut PassBuilder) {
    // Add a callback to parse a name from the textual representation of
    // the pipeline to be run.
    builder.add_module_pipeline_parsing_callback(|name, manager| {
        if name == "custom-pass" {
            // the input pipeline contains the name "custom-pass",
            // so we add our custom pass to the pass manager
            manager.add_pass(CustomPass);

            // we notify the caller that we were able to parse
            // the given name
            PipelineParsing::Parsed
        } else {
            // in any other cases, we notify the caller that our
            // callback wasn't able to parse the given name
            PipelineParsing::NotParsed
        }
    });
}

struct CustomPass;
impl LlvmModulePass for CustomPass {
    fn run_pass(
        &self,
        module: &mut Module,
        manager: &ModuleAnalysisManager
    ) -> PreservedAnalyses {
        // transform the IR
        todo!()
    }
}

现在，执行此命令将在某些输入 module.bc 上运行我们的自定义 pass

opt --load-pass-plugin=libplugin.so --passes=custom-pass module.bc -disable-output

但是，执行此命令不会（custom-pass2 无法被我们的插件解析）

opt --load-pass-plugin=libplugin.so --passes=custom-pass2 module.bc -disable-output

$ apt install llvm-14

$ brew install llvm@14