1 //==- RegisterUsageInfo.h - Register Usage Informartion Storage --*- C++ -*-==//
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
7 //===----------------------------------------------------------------------===//
9 /// This pass is required to take advantage of the interprocedural register
10 /// allocation infrastructure.
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.
16 //===----------------------------------------------------------------------===//
18 #ifndef LLVM_CODEGEN_PHYSICALREGISTERUSAGEINFO_H
19 #define LLVM_CODEGEN_PHYSICALREGISTERUSAGEINFO_H
21 #include "llvm/ADT/ArrayRef.h"
22 #include "llvm/ADT/DenseMap.h"
23 #include "llvm/IR/Instructions.h"
24 #include "llvm/Pass.h"
31 class LLVMTargetMachine;
33 class PhysicalRegisterUsageInfo : public ImmutablePass {
37 PhysicalRegisterUsageInfo() : ImmutablePass(ID) {
38 PassRegistry &Registry = *PassRegistry::getPassRegistry();
39 initializePhysicalRegisterUsageInfoPass(Registry);
42 /// Set TargetMachine which is used to print analysis.
43 void setTargetMachine(const LLVMTargetMachine &TM);
45 bool doInitialization(Module &M) override;
47 bool doFinalization(Module &M) override;
49 /// To store RegMask for given Function *.
50 void storeUpdateRegUsageInfo(const Function &FP,
51 ArrayRef<uint32_t> RegMask);
53 /// To query stored RegMask for given Function *, it will returns ane empty
54 /// array if function is not known.
55 ArrayRef<uint32_t> getRegUsageInfo(const Function &FP);
57 void print(raw_ostream &OS, const Module *M = nullptr) const override;
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.
63 DenseMap<const Function *, std::vector<uint32_t>> RegMasks;
65 const LLVMTargetMachine *TM;
68 } // end namespace llvm
70 #endif // LLVM_CODEGEN_PHYSICALREGISTERUSAGEINFO_H