aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/llvm12/lib/CodeGen/RegAllocBase.h
blob: d0eeb3d75b20c30207fddc900e8b5db0da429ef4 (plain) (blame)
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
//===- RegAllocBase.h - basic regalloc interface and driver -----*- C++ -*-===// 
// 
// 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 file defines the RegAllocBase class, which is the skeleton of a basic 
// register allocation algorithm and interface for extending it. It provides the 
// building blocks on which to construct other experimental allocators and test 
// the validity of two principles: 
// 
// - If virtual and physical register liveness is modeled using intervals, then 
// on-the-fly interference checking is cheap. Furthermore, interferences can be 
// lazily cached and reused. 
// 
// - Register allocation complexity, and generated code performance is 
// determined by the effectiveness of live range splitting rather than optimal 
// coloring. 
// 
// Following the first principle, interfering checking revolves around the 
// LiveIntervalUnion data structure. 
// 
// To fulfill the second principle, the basic allocator provides a driver for 
// incremental splitting. It essentially punts on the problem of register 
// coloring, instead driving the assignment of virtual to physical registers by 
// the cost of splitting. The basic allocator allows for heuristic reassignment 
// of registers, if a more sophisticated allocator chooses to do that. 
// 
// This framework provides a way to engineer the compile time vs. code 
// quality trade-off without relying on a particular theoretical solver. 
// 
//===----------------------------------------------------------------------===// 
 
#ifndef LLVM_LIB_CODEGEN_REGALLOCBASE_H 
#define LLVM_LIB_CODEGEN_REGALLOCBASE_H 
 
#include "llvm/ADT/SmallPtrSet.h" 
#include "llvm/CodeGen/RegisterClassInfo.h" 
 
namespace llvm { 
 
class LiveInterval; 
class LiveIntervals; 
class LiveRegMatrix; 
class MachineInstr; 
class MachineRegisterInfo; 
template<typename T> class SmallVectorImpl; 
class Spiller; 
class TargetRegisterInfo; 
class VirtRegMap; 
 
/// RegAllocBase provides the register allocation driver and interface that can 
/// be extended to add interesting heuristics. 
/// 
/// Register allocators must override the selectOrSplit() method to implement 
/// live range splitting. They must also override enqueue/dequeue to provide an 
/// assignment order. 
class RegAllocBase { 
  virtual void anchor(); 
 
protected: 
  const TargetRegisterInfo *TRI = nullptr; 
  MachineRegisterInfo *MRI = nullptr; 
  VirtRegMap *VRM = nullptr; 
  LiveIntervals *LIS = nullptr; 
  LiveRegMatrix *Matrix = nullptr; 
  RegisterClassInfo RegClassInfo; 
 
  /// Inst which is a def of an original reg and whose defs are already all 
  /// dead after remat is saved in DeadRemats. The deletion of such inst is 
  /// postponed till all the allocations are done, so its remat expr is 
  /// always available for the remat of all the siblings of the original reg. 
  SmallPtrSet<MachineInstr *, 32> DeadRemats; 
 
  RegAllocBase() = default; 
  virtual ~RegAllocBase() = default; 
 
  // A RegAlloc pass should call this before allocatePhysRegs. 
  void init(VirtRegMap &vrm, LiveIntervals &lis, LiveRegMatrix &mat); 
 
  // The top-level driver. The output is a VirtRegMap that us updated with 
  // physical register assignments. 
  void allocatePhysRegs(); 
 
  // Include spiller post optimization and removing dead defs left because of 
  // rematerialization. 
  virtual void postOptimization(); 
 
  // Get a temporary reference to a Spiller instance. 
  virtual Spiller &spiller() = 0; 
 
  /// enqueue - Add VirtReg to the priority queue of unassigned registers. 
  virtual void enqueue(LiveInterval *LI) = 0; 
 
  /// dequeue - Return the next unassigned register, or NULL. 
  virtual LiveInterval *dequeue() = 0; 
 
  // A RegAlloc pass should override this to provide the allocation heuristics. 
  // Each call must guarantee forward progess by returning an available PhysReg 
  // or new set of split live virtual registers. It is up to the splitter to 
  // converge quickly toward fully spilled live ranges. 
  virtual MCRegister selectOrSplit(LiveInterval &VirtReg,
                                   SmallVectorImpl<Register> &splitLVRs) = 0;
 
  // Use this group name for NamedRegionTimer. 
  static const char TimerGroupName[]; 
  static const char TimerGroupDescription[]; 
 
  /// Method called when the allocator is about to remove a LiveInterval. 
  virtual void aboutToRemoveInterval(LiveInterval &LI) {} 
 
public: 
  /// VerifyEnabled - True when -verify-regalloc is given. 
  static bool VerifyEnabled; 
 
private: 
  void seedLiveRegs(); 
}; 
 
} // end namespace llvm 
 
#endif // LLVM_LIB_CODEGEN_REGALLOCBASE_H