aboutsummaryrefslogtreecommitdiff
path: root/backend/include/rcc/IR/PassInstrumentation.h
blob: b0a673a3a02bb13461bfc6d63f31e9c621491236 (plain)
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
// SPDX-License-Identifier: GPL-3.0-or-later

#ifndef RCC_IR_PASSINSTRUMENTATION_H
#define RCC_IR_PASSINSTRUMENTATION_H

#include "rcc/Support/Error.h"

#include <cstdint>
#include <functional>
#include <mutex>
#include <string_view>
#include <utility>
#include <vector>

namespace rcc {

enum class InstrumentationPhase : std::uint8_t {
  Before,
  After,
};

template <typename IRUnitT, typename PassResultT> class PassInstrumentationCallbacks final {
public:
  using BeforeCallback = std::function<void(std::string_view, const IRUnitT &)>;
  using AfterCallback = std::function<void(std::string_view, const IRUnitT &, const PassResultT &)>;
  using FailureCallback = std::function<void(std::string_view, const IRUnitT &, const Error &)>;
  using BeforeAnalysisCallback = std::function<void(std::string_view, const IRUnitT &)>;
  using AfterAnalysisCallback =
      std::function<void(std::string_view, const IRUnitT &, bool, std::uint64_t)>;
  using AnalysisFailureCallback =
      std::function<void(std::string_view, const IRUnitT &, const Error &)>;

  void addBeforeCallback(BeforeCallback Callback) {
    addCallback(Before, std::move(Callback));
  }

  void addAfterCallback(AfterCallback Callback) {
    addCallback(After, std::move(Callback));
  }

  void addFailureCallback(FailureCallback Callback) {
    addCallback(Failure, std::move(Callback));
  }

  void addBeforeAnalysisCallback(BeforeAnalysisCallback Callback) {
    addCallback(BeforeAnalysis, std::move(Callback));
  }

  void addAfterAnalysisCallback(AfterAnalysisCallback Callback) {
    addCallback(AfterAnalysis, std::move(Callback));
  }

  void addAnalysisFailureCallback(AnalysisFailureCallback Callback) {
    addCallback(AnalysisFailure, std::move(Callback));
  }

  void runBefore(std::string_view Name, const IRUnitT &Unit) const {
    for (const BeforeCallback &Callback : snapshot(Before))
      Callback(Name, Unit);
  }

  void runAfter(std::string_view Name, const IRUnitT &Unit, const PassResultT &Result) const {
    for (const AfterCallback &Callback : snapshot(After))
      Callback(Name, Unit, Result);
  }

  void runFailure(std::string_view Name, const IRUnitT &Unit, const Error &FailureValue) const {
    for (const FailureCallback &Callback : snapshot(Failure))
      Callback(Name, Unit, FailureValue);
  }

  void runBeforeAnalysis(std::string_view Name, const IRUnitT &Unit) const {
    for (const BeforeAnalysisCallback &Callback : snapshot(BeforeAnalysis))
      Callback(Name, Unit);
  }

  void runAfterAnalysis(std::string_view Name, const IRUnitT &Unit, bool CacheHit,
                        std::uint64_t Nanoseconds) const {
    for (const AfterAnalysisCallback &Callback : snapshot(AfterAnalysis))
      Callback(Name, Unit, CacheHit, Nanoseconds);
  }

  void runAnalysisFailure(std::string_view Name, const IRUnitT &Unit,
                          const Error &FailureValue) const {
    for (const AnalysisFailureCallback &Callback : snapshot(AnalysisFailure))
      Callback(Name, Unit, FailureValue);
  }

  [[nodiscard]] bool empty() const {
    std::scoped_lock Lock(Mutex);
    return Before.empty() && After.empty() && Failure.empty() && BeforeAnalysis.empty() &&
           AfterAnalysis.empty() && AnalysisFailure.empty();
  }

private:
  template <typename CallbackT>
  void addCallback(std::vector<CallbackT> &Callbacks, CallbackT Callback) {
    if (!Callback)
      return;
    std::scoped_lock Lock(Mutex);
    Callbacks.push_back(std::move(Callback));
  }

  template <typename CallbackT>
  [[nodiscard]] std::vector<CallbackT> snapshot(const std::vector<CallbackT> &Callbacks) const {
    std::scoped_lock Lock(Mutex);
    return Callbacks;
  }

  mutable std::mutex Mutex;
  std::vector<BeforeCallback> Before;
  std::vector<AfterCallback> After;
  std::vector<FailureCallback> Failure;
  std::vector<BeforeAnalysisCallback> BeforeAnalysis;
  std::vector<AfterAnalysisCallback> AfterAnalysis;
  std::vector<AnalysisFailureCallback> AnalysisFailure;
};

} // namespace rcc

#endif // RCC_IR_PASSINSTRUMENTATION_H