aboutsummaryrefslogtreecommitdiff
path: root/backend/include/rcc/CodeGen/MachineAnalyses.h
blob: eda550d7460902a57d72927e338d7453854daf51 (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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
// SPDX-License-Identifier: GPL-3.0-or-later

#ifndef RCC_CODEGEN_MACHINEANALYSES_H
#define RCC_CODEGEN_MACHINEANALYSES_H

#include "rcc/CodeGen/MachineBasicBlock.h"
#include "rcc/CodeGen/MachineIRTypes.h"
#include "rcc/CodeGen/MachinePass.h"
#include "rcc/CodeGen/StableID.h"
#include "rcc/Support/Error.h"

#include <cstddef>
#include <cstdint>
#include <span>
#include <string_view>
#include <unordered_map>
#include <unordered_set>
#include <vector>

namespace rcc {

class MachineBasicBlock;
class MachineFunction;
class MachineInstr;
class MachineMemOperand;
class TargetDescription;

class MachineDominatorTreeAnalysis final {
public:
  class Result final {
  public:
    [[nodiscard]] bool isReachable(const MachineBasicBlock &Block) const noexcept;
    [[nodiscard]] bool dominates(const MachineBasicBlock &Dominator,
                                 const MachineBasicBlock &Block) const noexcept;
    [[nodiscard]] bool dominates(const MachineInstr &Dominator,
                                 const MachineInstr &Instruction) const noexcept;
    [[nodiscard]] const MachineBasicBlock *
    immediateDominator(const MachineBasicBlock &Block) const noexcept;
    [[nodiscard]] const MachineBasicBlock *
    nearestCommonDominator(const MachineBasicBlock &Left,
                           const MachineBasicBlock &Right) const noexcept;
    [[nodiscard]] std::span<MachineBasicBlock *const> unreachableBlocks() const noexcept {
      return UnreachableBlocks;
    }

    [[nodiscard]] Expected<void> updateAfterCFGChange(MachineFunction &Function);

  private:
    [[nodiscard]] Expected<void> build(MachineFunction &Function);

    std::vector<MachineBasicBlock *> Blocks;
    std::unordered_map<const MachineBasicBlock *, std::size_t> BlockToIndex;
    std::vector<std::vector<bool>> Dominators;
    std::vector<const MachineBasicBlock *> ImmediateDominators;
    std::vector<bool> Reachable;
    std::vector<MachineBasicBlock *> UnreachableBlocks;

    friend class MachineDominatorTreeAnalysis;
  };

  [[nodiscard]] static constexpr std::string_view name() noexcept {
    return "MachineDominatorTree";
  }

  [[nodiscard]] static Expected<Result>
  run(MachineFunction &Function, const TargetDescription &Target, MachineAnalysisManager &Analyses);
};

struct MachineLoop final {
  MachineBasicBlock *Header = nullptr;
  std::vector<MachineBasicBlock *> Blocks;
  std::vector<MachineBasicBlock *> Latches;
  std::size_t Parent = static_cast<std::size_t>(-1);
  std::vector<std::size_t> Children;
  std::uint32_t Depth = 1;
};

struct IrreducibleMachineRegion final {
  std::vector<MachineBasicBlock *> Blocks;
  std::vector<MachineBasicBlock *> Entries;
};

class MachineLoopAnalysis final {
public:
  class Result final {
  public:
    [[nodiscard]] std::span<const MachineLoop> loops() const noexcept {
      return Loops;
    }
    [[nodiscard]] std::span<const IrreducibleMachineRegion> irreducibleRegions() const noexcept {
      return IrreducibleRegions;
    }
    [[nodiscard]] const MachineLoop *loopFor(const MachineBasicBlock &Block) const noexcept;
    [[nodiscard]] std::uint32_t loopDepth(const MachineBasicBlock &Block) const noexcept;
    [[nodiscard]] bool isIrreducible(const MachineBasicBlock &Block) const noexcept;

  private:
    std::vector<MachineLoop> Loops;
    std::vector<IrreducibleMachineRegion> IrreducibleRegions;
    std::unordered_map<const MachineBasicBlock *, std::size_t> InnermostLoop;
    std::unordered_set<const MachineBasicBlock *> IrreducibleBlocks;

    friend class MachineLoopAnalysis;
  };

  [[nodiscard]] static constexpr std::string_view name() noexcept {
    return "MachineLoopInfo";
  }

  [[nodiscard]] static Expected<Result>
  run(MachineFunction &Function, const TargetDescription &Target, MachineAnalysisManager &Analyses);
};

class MachineBranchProbabilityAnalysis final {
public:
  class Result final {
  public:
    [[nodiscard]] BranchProbability probability(const MachineBasicBlock &From,
                                                const MachineBasicBlock &To) const noexcept;
    [[nodiscard]] std::span<const MachineSuccessor>
    successors(const MachineBasicBlock &Block) const noexcept;

  private:
    std::unordered_map<const MachineBasicBlock *, std::vector<MachineSuccessor>> Probabilities;

    friend class MachineBranchProbabilityAnalysis;
  };

  [[nodiscard]] static constexpr std::string_view name() noexcept {
    return "MachineBranchProbability";
  }

  [[nodiscard]] static Expected<Result>
  run(MachineFunction &Function, const TargetDescription &Target, MachineAnalysisManager &Analyses);
};

class MachineBlockFrequencyAnalysis final {
public:
  static constexpr std::uint64_t EntryFrequency = std::uint64_t{1} << 32U;

  class Result final {
  public:
    [[nodiscard]] std::uint64_t frequency(const MachineBasicBlock &Block) const noexcept;

  private:
    std::unordered_map<const MachineBasicBlock *, std::uint64_t> Frequencies;

    friend class MachineBlockFrequencyAnalysis;
  };

  [[nodiscard]] static constexpr std::string_view name() noexcept {
    return "MachineBlockFrequency";
  }

  [[nodiscard]] static Expected<Result>
  run(MachineFunction &Function, const TargetDescription &Target, MachineAnalysisManager &Analyses);
};

enum class MachineAliasResult : std::uint8_t {
  NoAlias,
  MayAlias,
  PartialAlias,
  MustAlias,
};

class MachineAliasAnalysis final {
public:
  class Result final {
  public:
    [[nodiscard]] MachineAliasResult alias(const MachineMemOperand &Left,
                                           const MachineMemOperand &Right) const noexcept;
  };

  [[nodiscard]] static constexpr std::string_view name() noexcept {
    return "MachineAliasAnalysis";
  }

  [[nodiscard]] static Expected<Result>
  run(MachineFunction &Function, const TargetDescription &Target, MachineAnalysisManager &Analyses);
};

enum class MachineMemoryDependencyKind : std::uint8_t {
  Flow,
  Anti,
  Output,
  Ordered,
};

struct MachineMemoryDependency final {
  MachineInstrStableID Source;
  MachineInstrStableID Destination;
  MachineMemoryDependencyKind Kind = MachineMemoryDependencyKind::Ordered;
};

struct MachineMemoryDependenceRegion final {
  const MachineBasicBlock *Block = nullptr;
  std::vector<MachineInstrStableID> Instructions;
};

class MachineMemoryDependenceAnalysis final {
public:
  class Result final {
  public:
    [[nodiscard]] std::span<const MachineMemoryDependenceRegion> regions() const noexcept {
      return Regions;
    }
    [[nodiscard]] const MachineMemoryDependenceRegion *
    regionFor(const MachineBasicBlock &Block) const noexcept;
    [[nodiscard]] std::span<const MachineMemoryDependency>
    dependencies(const MachineBasicBlock &Block) const noexcept;
    [[nodiscard]] std::span<const MachineMemoryDependency>
    dependencies(const MachineInstr &Instruction) const noexcept;
    [[nodiscard]] std::span<const MachineMemoryDependency> allDependencies() const noexcept {
      return Dependencies;
    }

  private:
    struct Range final {
      std::size_t Begin = 0;
      std::size_t Size = 0;
    };

    std::vector<MachineMemoryDependency> Dependencies;
    std::vector<MachineMemoryDependenceRegion> Regions;
    std::unordered_map<const MachineBasicBlock *, std::size_t> BlockToRegion;
    std::unordered_map<const MachineBasicBlock *, Range> BlockRanges;
    std::unordered_map<MachineInstrStableID, Range> DestinationRanges;

    friend class MachineMemoryDependenceAnalysis;
  };

  [[nodiscard]] static constexpr std::string_view name() noexcept {
    return "MachineMemoryDependence";
  }

  [[nodiscard]] static Expected<Result>
  run(MachineFunction &Function, const TargetDescription &Target, MachineAnalysisManager &Analyses);
};

[[nodiscard]] Expected<void> registerStage8MachineAnalyses(MachineAnalysisManager &Analyses);

} // namespace rcc

#endif // RCC_CODEGEN_MACHINEANALYSES_H