Add explicit keywords.
[oota-llvm.git] / lib / Target / PowerPC / PPCMachineFunctionInfo.h
1 //===-- PPCMachineFunctionInfo.h - Private data used for PowerPC --*- 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 PowerPC specific subclass of MachineFunctionInfo.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef PPC_MACHINE_FUNCTION_INFO_H
15 #define PPC_MACHINE_FUNCTION_INFO_H
16
17 #include "llvm/CodeGen/MachineFunction.h"
18
19 namespace llvm {
20
21 /// PPCFunctionInfo - This class is derived from MachineFunction private
22 /// PowerPC target-specific information for each MachineFunction.
23 class PPCFunctionInfo : public MachineFunctionInfo {
24 private:
25   /// FramePointerSaveIndex - Frame index of where the old frame pointer is
26   /// stored.  Also used as an anchor for instructions that need to be altered
27   /// when using frame pointers (dyna_add, dyna_sub.)
28   int FramePointerSaveIndex;
29   
30   /// ReturnAddrSaveIndex - Frame index of where the return address is stored.
31   ///
32   int ReturnAddrSaveIndex;
33
34   /// MustSaveLR - Indicates whether LR is defined (or clobbered) in the current
35   /// function.  This is only valid after the initial scan of the function by
36   /// PEI.
37   bool MustSaveLR;
38
39   /// SpillsCR - Indicates whether CR is spilled in the current function.
40   bool SpillsCR;
41
42   /// LRStoreRequired - The bool indicates whether there is some explicit use of
43   /// the LR/LR8 stack slot that is not obvious from scanning the code.  This
44   /// requires that the code generator produce a store of LR to the stack on
45   /// entry, even though LR may otherwise apparently not be used.
46   bool LRStoreRequired;
47
48   /// MinReservedArea - This is the frame size that is at least reserved in a
49   /// potential caller (parameter+linkage area).
50   unsigned MinReservedArea;
51
52   /// TailCallSPDelta - Stack pointer delta used when tail calling. Maximum
53   /// amount the stack pointer is adjusted to make the frame bigger for tail
54   /// calls. Used for creating an area before the register spill area.
55   int TailCallSPDelta;
56
57   /// HasFastCall - Does this function contain a fast call. Used to determine
58   /// how the caller's stack pointer should be calculated (epilog/dynamicalloc).
59   bool HasFastCall;
60
61 public:
62   explicit PPCFunctionInfo(MachineFunction &MF) 
63     : FramePointerSaveIndex(0),
64       ReturnAddrSaveIndex(0),
65       SpillsCR(false),
66       LRStoreRequired(false),
67       MinReservedArea(0),
68       TailCallSPDelta(0),
69       HasFastCall(false) {}
70
71   int getFramePointerSaveIndex() const { return FramePointerSaveIndex; }
72   void setFramePointerSaveIndex(int Idx) { FramePointerSaveIndex = Idx; }
73   
74   int getReturnAddrSaveIndex() const { return ReturnAddrSaveIndex; }
75   void setReturnAddrSaveIndex(int idx) { ReturnAddrSaveIndex = idx; }
76
77   unsigned getMinReservedArea() const { return MinReservedArea; }
78   void setMinReservedArea(unsigned size) { MinReservedArea = size; }
79
80   int getTailCallSPDelta() const { return TailCallSPDelta; }
81   void setTailCallSPDelta(int size) { TailCallSPDelta = size; }
82
83   /// MustSaveLR - This is set when the prolog/epilog inserter does its initial
84   /// scan of the function. It is true if the LR/LR8 register is ever explicitly
85   /// defined/clobbered in the machine function (e.g. by calls and movpctolr,
86   /// which is used in PIC generation), or if the LR stack slot is explicitly
87   /// referenced by builtin_return_address.
88   void setMustSaveLR(bool U) { MustSaveLR = U; }
89   bool mustSaveLR() const    { return MustSaveLR; }
90
91   void setSpillsCR()       { SpillsCR = true; }
92   bool isCRSpilled() const { return SpillsCR; }
93
94   void setLRStoreRequired() { LRStoreRequired = true; }
95   bool isLRStoreRequired() const { return LRStoreRequired; }
96
97   void setHasFastCall() { HasFastCall = true; }
98   bool hasFastCall() const { return HasFastCall;}
99 };
100
101 } // end of namespace llvm
102
103
104 #endif