LLVM  9.0.0svn
RegisterUsageInfo.h
Go to the documentation of this file.
1 //==- RegisterUsageInfo.h - Register Usage Informartion Storage --*- C++ -*-==//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 /// \file
9 /// This pass is required to take advantage of the interprocedural register
10 /// allocation infrastructure.
11 ///
12 /// This pass is simple immutable pass which keeps RegMasks (calculated based on
13 /// actual register allocation) for functions in a module and provides simple
14 /// API to query this information.
15 ///
16 //===----------------------------------------------------------------------===//
17 
18 #ifndef LLVM_CODEGEN_PHYSICALREGISTERUSAGEINFO_H
19 #define LLVM_CODEGEN_PHYSICALREGISTERUSAGEINFO_H
20 
21 #include "llvm/ADT/ArrayRef.h"
22 #include "llvm/ADT/DenseMap.h"
23 #include "llvm/IR/Instructions.h"
24 #include "llvm/Pass.h"
25 #include <cstdint>
26 #include <vector>
27 
28 namespace llvm {
29 
30 class Function;
31 class LLVMTargetMachine;
32 
34 public:
35  static char ID;
36 
40  }
41 
42  /// Set TargetMachine which is used to print analysis.
43  void setTargetMachine(const LLVMTargetMachine &TM);
44 
45  bool doInitialization(Module &M) override;
46 
47  bool doFinalization(Module &M) override;
48 
49  /// To store RegMask for given Function *.
51  ArrayRef<uint32_t> RegMask);
52 
53  /// To query stored RegMask for given Function *, it will returns ane empty
54  /// array if function is not known.
56 
57  void print(raw_ostream &OS, const Module *M = nullptr) const override;
58 
59 private:
60  /// A Dense map from Function * to RegMask.
61  /// In RegMask 0 means register used (clobbered) by function.
62  /// and 1 means content of register will be preserved around function call.
64 
65  const LLVMTargetMachine *TM;
66 };
67 
68 } // end namespace llvm
69 
70 #endif // LLVM_CODEGEN_PHYSICALREGISTERUSAGEINFO_H
ArrayRef< uint32_t > getRegUsageInfo(const Function &FP)
To query stored RegMask for given Function *, it will returns ane empty array if function is not know...
static PassRegistry * getPassRegistry()
getPassRegistry - Access the global registry object, which is automatically initialized at applicatio...
This class represents lattice values for constants.
Definition: AllocatorList.h:23
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:65
A global registry used in conjunction with static constructors to make pluggable components (like tar...
Definition: Registry.h:44
void print(raw_ostream &OS, const Module *M=nullptr) const override
print - Print out the internal state of the pass.
bool doInitialization(Module &M) override
doInitialization - Virtual method overridden by subclasses to do any necessary initialization before ...
bool doFinalization(Module &M) override
doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes...
void initializePhysicalRegisterUsageInfoPass(PassRegistry &)
void storeUpdateRegUsageInfo(const Function &FP, ArrayRef< uint32_t > RegMask)
To store RegMask for given Function *.
void setTargetMachine(const LLVMTargetMachine &TM)
Set TargetMachine which is used to print analysis.
This class describes a target machine that is implemented with the LLVM target-independent code gener...
ImmutablePass class - This class is used to provide information that does not need to be run...
Definition: Pass.h:255
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:45
PassRegistry - This class manages the registration and intitialization of the pass subsystem as appli...
Definition: PassRegistry.h:38