1 //===-- MipsMachineFunctionInfo.h - Private data used for Mips ----*- C++ -*-=//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file declares the Mips specific subclass of MachineFunctionInfo.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef MIPS_MACHINE_FUNCTION_INFO_H
15 #define MIPS_MACHINE_FUNCTION_INFO_H
16 
17 #include "Mips16HardFloatInfo.h"
18 #include "MipsSubtarget.h"
19 #include "llvm/ADT/StringMap.h"
20 #include "llvm/CodeGen/MachineFrameInfo.h"
21 #include "llvm/CodeGen/MachineFunction.h"
22 #include "llvm/CodeGen/MachineMemOperand.h"
23 #include "llvm/CodeGen/PseudoSourceValue.h"
24 #include "llvm/IR/GlobalValue.h"
25 #include "llvm/IR/ValueMap.h"
26 #include "llvm/Target/TargetFrameLowering.h"
27 #include "llvm/Target/TargetMachine.h"
28 #include <map>
29 #include <string>
30 #include <utility>
31 
32 namespace llvm {
33 
34 /// \brief A class derived from PseudoSourceValue that represents a GOT entry
35 /// resolved by lazy-binding.
36 class MipsCallEntry : public PseudoSourceValue {
37 public:
38   explicit MipsCallEntry(const StringRef &N);
39   explicit MipsCallEntry(const GlobalValue *V);
40   bool isConstant(const MachineFrameInfo *) const override;
41   bool isAliased(const MachineFrameInfo *) const override;
42   bool mayAlias(const MachineFrameInfo *) const override;
43 
44 private:
45   void printCustom(raw_ostream &O) const override;
46 #ifndef NDEBUG
47   std::string Name;
48   const GlobalValue *Val;
49 #endif
50 };
51 
52 /// MipsFunctionInfo - This class is derived from MachineFunction private
53 /// Mips target-specific information for each MachineFunction.
54 class MipsFunctionInfo : public MachineFunctionInfo {
55 public:
56   MipsFunctionInfo(MachineFunction &MF)
57       : MF(MF), SRetReturnReg(0), GlobalBaseReg(0), Mips16SPAliasReg(0),
58         VarArgsFrameIndex(0), CallsEhReturn(false), SaveS2(false) {}
59 
60   ~MipsFunctionInfo();
61 
62   unsigned getSRetReturnReg() const { return SRetReturnReg; }
63   void setSRetReturnReg(unsigned Reg) { SRetReturnReg = Reg; }
64 
65   bool globalBaseRegSet() const;
66   unsigned getGlobalBaseReg();
67 
68   bool mips16SPAliasRegSet() const;
69   unsigned getMips16SPAliasReg();
70 
71   int getVarArgsFrameIndex() const { return VarArgsFrameIndex; }
72   void setVarArgsFrameIndex(int Index) { VarArgsFrameIndex = Index; }
73 
74   bool hasByvalArg() const { return HasByvalArg; }
75   void setFormalArgInfo(unsigned Size, bool HasByval) {
76     IncomingArgSize = Size;
77     HasByvalArg = HasByval;
78   }
79 
80   unsigned getIncomingArgSize() const { return IncomingArgSize; }
81 
82   bool callsEhReturn() const { return CallsEhReturn; }
83   void setCallsEhReturn() { CallsEhReturn = true; }
84 
85   void createEhDataRegsFI();
86   int getEhDataRegFI(unsigned Reg) const { return EhDataRegFI[Reg]; }
87   bool isEhDataRegFI(int FI) const;
88 
89   /// \brief Create a MachinePointerInfo that has a MipsCallEntr object
90   /// representing a GOT entry for an external function.
91   MachinePointerInfo callPtrInfo(const StringRef &Name);
92 
93   /// \brief Create a MachinePointerInfo that has a MipsCallEntr object
94   /// representing a GOT entry for a global function.
95   MachinePointerInfo callPtrInfo(const GlobalValue *Val);
96 
97   void setSaveS2() { SaveS2 = true; }
98   bool hasSaveS2() const { return SaveS2; }
99 
100   std::map<const char *, const llvm::Mips16HardFloatInfo::FuncSignature *>
101   StubsNeeded;
102 
103 private:
104   virtual void anchor();
105 
106   MachineFunction& MF;
107   /// SRetReturnReg - Some subtargets require that sret lowering includes
108   /// returning the value of the returned struct in a register. This field
109   /// holds the virtual register into which the sret argument is passed.
110   unsigned SRetReturnReg;
111 
112   /// GlobalBaseReg - keeps track of the virtual register initialized for
113   /// use as the global base register. This is used for PIC in some PIC
114   /// relocation models.
115   unsigned GlobalBaseReg;
116 
117   /// Mips16SPAliasReg - keeps track of the virtual register initialized for
118   /// use as an alias for SP for use in load/store of halfword/byte from/to
119   /// the stack
120   unsigned Mips16SPAliasReg;
121 
122   /// VarArgsFrameIndex - FrameIndex for start of varargs area.
123   int VarArgsFrameIndex;
124 
125   /// True if function has a byval argument.
126   bool HasByvalArg;
127 
128   /// Size of incoming argument area.
129   unsigned IncomingArgSize;
130 
131   /// CallsEhReturn - Whether the function calls llvm.eh.return.
132   bool CallsEhReturn;
133 
134   /// Frame objects for spilling eh data registers.
135   int EhDataRegFI[4];
136 
137   // saveS2
138   bool SaveS2;
139 
140   /// MipsCallEntry maps.
141   StringMap<const MipsCallEntry *> ExternalCallEntries;
142   ValueMap<const GlobalValue *, const MipsCallEntry *> GlobalCallEntries;
143 };
144 
145 } // end of namespace llvm
146 
147 #endif // MIPS_MACHINE_FUNCTION_INFO_H
148