llvm-plugin 0.6.0

A wrapper for easily implementing out-of-source-tree LLVM plugins in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

#pragma once

#include <memory>
#include <mutex>
#include <type_traits>
#include <utility>

#include <llvm/IR/PassManager.h>

#include "common.hh"

namespace {

template <typename IR>
struct Analysis : public llvm::AnalysisInfoMixin<Analysis<IR>> {
  using DataPtr = const void *;
  using DataDeleter = void (*)(DataPtr);
  using Data = std::unique_ptr<std::remove_pointer_t<DataPtr>, DataDeleter>;

  using ResultPtr = void *;
  using ResultDeleter = void (*)(ResultPtr);
  using Result =
      std::unique_ptr<std::remove_pointer_t<ResultPtr>, ResultDeleter>;

  using Entrypoint = void (*)(DataPtr, typename IR::Unit &,
                              typename IR::AnalysisManager &, ResultPtr &,
                              ResultDeleter &);

  Analysis(Entrypoint Func, Data AnalysisData)
      : AnalysisData(std::move(AnalysisData)) {
    this->Func = Func;
  }

  auto run(typename IR::Unit &IrUnit, typename IR::AnalysisManager &AM)
      -> Result {
    auto *Ptr = (ResultPtr) nullptr;
    auto Deleter = (ResultDeleter) nullptr;
    this->Func(this->AnalysisData.get(), IrUnit, AM, Ptr, Deleter);

    return {Ptr, Deleter};
  }

  static auto ID() // NOLINT(readability-identifier-naming)
      -> llvm::AnalysisKey * {
    return CurrentKey;
  }

  static inline auto CurrentKey = (llvm::AnalysisKey *)nullptr;
  static inline auto MutexCurrentKey = std::mutex{};

private:
  Entrypoint Func;
  Data AnalysisData;

  friend struct llvm::AnalysisInfoMixin<Analysis<IR>>;
};

} // namespace