Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 1 | //===- subzero/src/IceTargetLowering.h - Lowering interface -----*- C++ -*-===// |
| 2 | // |
| 3 | // The Subzero Code Generator |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
Andrew Scull | 9612d32 | 2015-07-06 14:53:25 -0700 | [diff] [blame] | 9 | /// |
| 10 | /// \file |
Jim Stichnoth | 92a6e5b | 2015-12-02 16:52:44 -0800 | [diff] [blame] | 11 | /// \brief Declares the TargetLowering, LoweringContext, and TargetDataLowering |
| 12 | /// classes. |
| 13 | /// |
| 14 | /// TargetLowering is an abstract class used to drive the translation/lowering |
| 15 | /// process. LoweringContext maintains a context for lowering each instruction, |
| 16 | /// offering conveniences such as iterating over non-deleted instructions. |
| 17 | /// TargetDataLowering is an abstract class used to drive the lowering/emission |
| 18 | /// of global initializers, external global declarations, and internal constant |
| 19 | /// pools. |
Andrew Scull | 9612d32 | 2015-07-06 14:53:25 -0700 | [diff] [blame] | 20 | /// |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 21 | //===----------------------------------------------------------------------===// |
| 22 | |
| 23 | #ifndef SUBZERO_SRC_ICETARGETLOWERING_H |
| 24 | #define SUBZERO_SRC_ICETARGETLOWERING_H |
| 25 | |
John Porto | 1d937a8 | 2015-12-17 06:19:34 -0800 | [diff] [blame^] | 26 | #include "IceCfgNode.h" |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 27 | #include "IceDefs.h" |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 28 | #include "IceInst.h" // for the names of the Inst subtypes |
Jan Voung | 76bb0be | 2015-05-14 09:26:19 -0700 | [diff] [blame] | 29 | #include "IceOperand.h" |
Jim Stichnoth | a18cc9c | 2014-09-30 19:10:22 -0700 | [diff] [blame] | 30 | #include "IceTypes.h" |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 31 | |
John Porto | 1d937a8 | 2015-12-17 06:19:34 -0800 | [diff] [blame^] | 32 | #include <utility> |
| 33 | |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 34 | namespace Ice { |
| 35 | |
Karl Schimpf | c5abdc1 | 2015-10-09 13:29:13 -0700 | [diff] [blame] | 36 | // UnimplementedError is defined as a macro so that we can get actual line |
| 37 | // numbers. |
| 38 | #define UnimplementedError(Flags) \ |
| 39 | do { \ |
| 40 | if (!static_cast<const ClFlags &>(Flags).getSkipUnimplemented()) { \ |
| 41 | /* Use llvm_unreachable instead of report_fatal_error, which gives \ |
| 42 | better stack traces. */ \ |
| 43 | llvm_unreachable("Not yet implemented"); \ |
| 44 | abort(); \ |
| 45 | } \ |
| 46 | } while (0) |
| 47 | |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 48 | /// LoweringContext makes it easy to iterate through non-deleted instructions in |
| 49 | /// a node, and insert new (lowered) instructions at the current point. Along |
| 50 | /// with the instruction list container and associated iterators, it holds the |
| 51 | /// current node, which is needed when inserting new instructions in order to |
| 52 | /// track whether variables are used as single-block or multi-block. |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 53 | class LoweringContext { |
Jim Stichnoth | 7b451a9 | 2014-10-15 14:39:23 -0700 | [diff] [blame] | 54 | LoweringContext(const LoweringContext &) = delete; |
| 55 | LoweringContext &operator=(const LoweringContext &) = delete; |
| 56 | |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 57 | public: |
Jim Stichnoth | eafb56c | 2015-06-22 10:35:22 -0700 | [diff] [blame] | 58 | LoweringContext() = default; |
| 59 | ~LoweringContext() = default; |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 60 | void init(CfgNode *Node); |
| 61 | Inst *getNextInst() const { |
| 62 | if (Next == End) |
Jim Stichnoth | ae95320 | 2014-12-20 06:17:49 -0800 | [diff] [blame] | 63 | return nullptr; |
Jim Stichnoth | 607e9f0 | 2014-11-06 13:32:05 -0800 | [diff] [blame] | 64 | return Next; |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 65 | } |
Jan Voung | c820ddf | 2014-07-29 14:38:51 -0700 | [diff] [blame] | 66 | Inst *getNextInst(InstList::iterator &Iter) const { |
Jan Voung | e6e497d | 2014-07-30 10:06:03 -0700 | [diff] [blame] | 67 | advanceForward(Iter); |
Jan Voung | c820ddf | 2014-07-29 14:38:51 -0700 | [diff] [blame] | 68 | if (Iter == End) |
Jim Stichnoth | ae95320 | 2014-12-20 06:17:49 -0800 | [diff] [blame] | 69 | return nullptr; |
Jim Stichnoth | 607e9f0 | 2014-11-06 13:32:05 -0800 | [diff] [blame] | 70 | return Iter; |
Jan Voung | c820ddf | 2014-07-29 14:38:51 -0700 | [diff] [blame] | 71 | } |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 72 | CfgNode *getNode() const { return Node; } |
| 73 | bool atEnd() const { return Cur == End; } |
| 74 | InstList::iterator getCur() const { return Cur; } |
Jim Stichnoth | 5d2fa0c | 2014-12-01 09:30:55 -0800 | [diff] [blame] | 75 | InstList::iterator getNext() const { return Next; } |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 76 | InstList::iterator getEnd() const { return End; } |
| 77 | void insert(Inst *Inst); |
John Porto | 1d937a8 | 2015-12-17 06:19:34 -0800 | [diff] [blame^] | 78 | template <typename Inst, typename... Args> Inst *insert(Args &&... A) { |
| 79 | auto *New = Inst::create(Node->getCfg(), std::forward<Args>(A)...); |
| 80 | insert(New); |
| 81 | return New; |
| 82 | } |
Jan Voung | e6e497d | 2014-07-30 10:06:03 -0700 | [diff] [blame] | 83 | Inst *getLastInserted() const; |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 84 | void advanceCur() { Cur = Next; } |
Jan Voung | e6e497d | 2014-07-30 10:06:03 -0700 | [diff] [blame] | 85 | void advanceNext() { advanceForward(Next); } |
Jim Stichnoth | a3f57b9 | 2015-07-30 12:46:04 -0700 | [diff] [blame] | 86 | void setCur(InstList::iterator C) { Cur = C; } |
| 87 | void setNext(InstList::iterator N) { Next = N; } |
Jim Stichnoth | 336f6c4 | 2014-10-30 15:01:31 -0700 | [diff] [blame] | 88 | void rewind(); |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 89 | void setInsertPoint(const InstList::iterator &Position) { Next = Position; } |
Jim Stichnoth | 318f4cd | 2015-10-01 21:02:37 -0700 | [diff] [blame] | 90 | void availabilityReset(); |
| 91 | void availabilityUpdate(); |
| 92 | Variable *availabilityGet(Operand *Src) const; |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 93 | |
| 94 | private: |
Andrew Scull | 9612d32 | 2015-07-06 14:53:25 -0700 | [diff] [blame] | 95 | /// Node is the argument to Inst::updateVars(). |
Jim Stichnoth | eafb56c | 2015-06-22 10:35:22 -0700 | [diff] [blame] | 96 | CfgNode *Node = nullptr; |
| 97 | Inst *LastInserted = nullptr; |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 98 | /// Cur points to the current instruction being considered. It is guaranteed |
| 99 | /// to point to a non-deleted instruction, or to be End. |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 100 | InstList::iterator Cur; |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 101 | /// Next doubles as a pointer to the next valid instruction (if any), and the |
| 102 | /// new-instruction insertion point. It is also updated for the caller in case |
| 103 | /// the lowering consumes more than one high-level instruction. It is |
| 104 | /// guaranteed to point to a non-deleted instruction after Cur, or to be End. |
| 105 | // TODO: Consider separating the notion of "next valid instruction" and "new |
| 106 | // instruction insertion point", to avoid confusion when previously-deleted |
| 107 | // instructions come between the two points. |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 108 | InstList::iterator Next; |
Andrew Scull | 9612d32 | 2015-07-06 14:53:25 -0700 | [diff] [blame] | 109 | /// Begin is a copy of Insts.begin(), used if iterators are moved backward. |
Jan Voung | e6e497d | 2014-07-30 10:06:03 -0700 | [diff] [blame] | 110 | InstList::iterator Begin; |
Andrew Scull | 9612d32 | 2015-07-06 14:53:25 -0700 | [diff] [blame] | 111 | /// End is a copy of Insts.end(), used if Next needs to be advanced. |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 112 | InstList::iterator End; |
Jim Stichnoth | 318f4cd | 2015-10-01 21:02:37 -0700 | [diff] [blame] | 113 | /// LastDest and LastSrc capture the parameters of the last "Dest=Src" simple |
| 114 | /// assignment inserted (provided Src is a variable). This is used for simple |
| 115 | /// availability analysis. |
| 116 | Variable *LastDest = nullptr; |
| 117 | Variable *LastSrc = nullptr; |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 118 | |
Jan Voung | c820ddf | 2014-07-29 14:38:51 -0700 | [diff] [blame] | 119 | void skipDeleted(InstList::iterator &I) const; |
Jan Voung | e6e497d | 2014-07-30 10:06:03 -0700 | [diff] [blame] | 120 | void advanceForward(InstList::iterator &I) const; |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 121 | }; |
| 122 | |
Jan Voung | 28068ad | 2015-07-31 12:58:46 -0700 | [diff] [blame] | 123 | /// A helper class to advance the LoweringContext at each loop iteration. |
| 124 | class PostIncrLoweringContext { |
| 125 | PostIncrLoweringContext() = delete; |
| 126 | PostIncrLoweringContext(const PostIncrLoweringContext &) = delete; |
| 127 | PostIncrLoweringContext &operator=(const PostIncrLoweringContext &) = delete; |
| 128 | |
| 129 | public: |
| 130 | explicit PostIncrLoweringContext(LoweringContext &Context) |
| 131 | : Context(Context) {} |
| 132 | ~PostIncrLoweringContext() { |
| 133 | Context.advanceCur(); |
| 134 | Context.advanceNext(); |
| 135 | } |
| 136 | |
| 137 | private: |
| 138 | LoweringContext &Context; |
| 139 | }; |
| 140 | |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 141 | class TargetLowering { |
Jim Stichnoth | c6ead20 | 2015-02-24 09:30:30 -0800 | [diff] [blame] | 142 | TargetLowering() = delete; |
Jim Stichnoth | 7b451a9 | 2014-10-15 14:39:23 -0700 | [diff] [blame] | 143 | TargetLowering(const TargetLowering &) = delete; |
| 144 | TargetLowering &operator=(const TargetLowering &) = delete; |
| 145 | |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 146 | public: |
Jan Voung | b36ad9b | 2015-04-21 17:01:49 -0700 | [diff] [blame] | 147 | // TODO(jvoung): return a unique_ptr like the other factory functions. |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 148 | static TargetLowering *createLowering(TargetArch Target, Cfg *Func); |
Jim Stichnoth | 94844f1 | 2015-11-04 16:06:16 -0800 | [diff] [blame] | 149 | static void staticInit(TargetArch Target); |
| 150 | // Each target must define a public static method: |
| 151 | // static void staticInit(); |
Jan Voung | ec27073 | 2015-01-12 17:00:22 -0800 | [diff] [blame] | 152 | static std::unique_ptr<Assembler> createAssembler(TargetArch Target, |
| 153 | Cfg *Func); |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 154 | void translate() { |
Jan Voung | 1f47ad0 | 2015-03-20 15:01:26 -0700 | [diff] [blame] | 155 | switch (Ctx->getFlags().getOptLevel()) { |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 156 | case Opt_m1: |
| 157 | translateOm1(); |
| 158 | break; |
| 159 | case Opt_0: |
| 160 | translateO0(); |
| 161 | break; |
| 162 | case Opt_1: |
| 163 | translateO1(); |
| 164 | break; |
| 165 | case Opt_2: |
| 166 | translateO2(); |
| 167 | break; |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 168 | } |
| 169 | } |
| 170 | virtual void translateOm1() { |
| 171 | Func->setError("Target doesn't specify Om1 lowering steps."); |
| 172 | } |
| 173 | virtual void translateO0() { |
| 174 | Func->setError("Target doesn't specify O0 lowering steps."); |
| 175 | } |
| 176 | virtual void translateO1() { |
| 177 | Func->setError("Target doesn't specify O1 lowering steps."); |
| 178 | } |
| 179 | virtual void translateO2() { |
| 180 | Func->setError("Target doesn't specify O2 lowering steps."); |
| 181 | } |
| 182 | |
John Porto | 5e0a8a7 | 2015-11-20 13:50:36 -0800 | [diff] [blame] | 183 | /// Generates calls to intrinsics for operations the Target can't handle. |
| 184 | void genTargetHelperCalls(); |
Andrew Scull | 9612d32 | 2015-07-06 14:53:25 -0700 | [diff] [blame] | 185 | /// Tries to do address mode optimization on a single instruction. |
Jim Stichnoth | d97c7df | 2014-06-04 11:57:08 -0700 | [diff] [blame] | 186 | void doAddressOpt(); |
Andrew Scull | 9612d32 | 2015-07-06 14:53:25 -0700 | [diff] [blame] | 187 | /// Randomly insert NOPs. |
Qining Lu | aee5fa8 | 2015-08-20 14:59:03 -0700 | [diff] [blame] | 188 | void doNopInsertion(RandomNumberGenerator &RNG); |
Andrew Scull | 9612d32 | 2015-07-06 14:53:25 -0700 | [diff] [blame] | 189 | /// Lowers a single non-Phi instruction. |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 190 | void lower(); |
Jim Stichnoth | a3f57b9 | 2015-07-30 12:46:04 -0700 | [diff] [blame] | 191 | /// Inserts and lowers a single high-level instruction at a specific insertion |
| 192 | /// point. |
| 193 | void lowerInst(CfgNode *Node, InstList::iterator Next, InstHighLevel *Instr); |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 194 | /// Does preliminary lowering of the set of Phi instructions in the current |
| 195 | /// node. The main intention is to do what's needed to keep the unlowered Phi |
| 196 | /// instructions consistent with the lowered non-Phi instructions, e.g. to |
| 197 | /// lower 64-bit operands on a 32-bit target. |
Jim Stichnoth | 336f6c4 | 2014-10-30 15:01:31 -0700 | [diff] [blame] | 198 | virtual void prelowerPhis() {} |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 199 | /// Tries to do branch optimization on a single instruction. Returns true if |
| 200 | /// some optimization was done. |
Jim Stichnoth | ff9c706 | 2014-09-18 04:50:49 -0700 | [diff] [blame] | 201 | virtual bool doBranchOpt(Inst * /*I*/, const CfgNode * /*NextNode*/) { |
| 202 | return false; |
| 203 | } |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 204 | |
Jim Stichnoth | 3d44fe8 | 2014-11-01 10:10:18 -0700 | [diff] [blame] | 205 | virtual SizeT getNumRegisters() const = 0; |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 206 | /// Returns a variable pre-colored to the specified physical register. This is |
| 207 | /// generally used to get very direct access to the register such as in the |
| 208 | /// prolog or epilog or for marking scratch registers as killed by a call. If |
| 209 | /// a Type is not provided, a target-specific default type is used. |
Jim Stichnoth | 98712a3 | 2014-10-24 10:59:02 -0700 | [diff] [blame] | 210 | virtual Variable *getPhysicalRegister(SizeT RegNum, |
| 211 | Type Ty = IceType_void) = 0; |
Andrew Scull | 9612d32 | 2015-07-06 14:53:25 -0700 | [diff] [blame] | 212 | /// Returns a printable name for the register. |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 213 | virtual IceString getRegName(SizeT RegNum, Type Ty) const = 0; |
| 214 | |
| 215 | virtual bool hasFramePointer() const { return false; } |
David Sehr | e39d0ca | 2015-11-06 11:25:41 -0800 | [diff] [blame] | 216 | virtual void setHasFramePointer() = 0; |
Jim Stichnoth | e741871 | 2015-10-09 06:54:02 -0700 | [diff] [blame] | 217 | virtual SizeT getStackReg() const = 0; |
David Sehr | 2f3b8ec | 2015-11-16 16:51:39 -0800 | [diff] [blame] | 218 | virtual SizeT getFrameReg() const = 0; |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 219 | virtual SizeT getFrameOrStackReg() const = 0; |
Matt Wala | d4799f4 | 2014-08-14 14:24:12 -0700 | [diff] [blame] | 220 | virtual size_t typeWidthInBytesOnStack(Type Ty) const = 0; |
David Sehr | e39d0ca | 2015-11-06 11:25:41 -0800 | [diff] [blame] | 221 | virtual uint32_t getStackAlignment() const = 0; |
David Sehr | 2f3b8ec | 2015-11-16 16:51:39 -0800 | [diff] [blame] | 222 | virtual void reserveFixedAllocaArea(size_t Size, size_t Align) = 0; |
| 223 | virtual int32_t getFrameFixedAllocaOffset() const = 0; |
John Porto | 614140e | 2015-11-23 11:43:13 -0800 | [diff] [blame] | 224 | virtual uint32_t maxOutArgsSizeBytes() const { return 0; } |
Jan Voung | 0fa6c5a | 2015-06-01 11:04:04 -0700 | [diff] [blame] | 225 | |
Andrew Scull | 6d47bcd | 2015-09-17 17:10:05 -0700 | [diff] [blame] | 226 | /// Return whether a 64-bit Variable should be split into a Variable64On32. |
| 227 | virtual bool shouldSplitToVariable64On32(Type Ty) const = 0; |
| 228 | |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 229 | bool hasComputedFrame() const { return HasComputedFrame; } |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 230 | /// Returns true if this function calls a function that has the "returns |
| 231 | /// twice" attribute. |
Jan Voung | 44d53e1 | 2014-09-11 19:18:03 -0700 | [diff] [blame] | 232 | bool callsReturnsTwice() const { return CallsReturnsTwice; } |
Jim Stichnoth | dd842db | 2015-01-27 12:53:53 -0800 | [diff] [blame] | 233 | void setCallsReturnsTwice(bool RetTwice) { CallsReturnsTwice = RetTwice; } |
Jan Voung | b36ad9b | 2015-04-21 17:01:49 -0700 | [diff] [blame] | 234 | SizeT makeNextLabelNumber() { return NextLabelNumber++; } |
Andrew Scull | 86df4e9 | 2015-07-30 13:54:44 -0700 | [diff] [blame] | 235 | SizeT makeNextJumpTableNumber() { return NextJumpTableNumber++; } |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 236 | LoweringContext &getContext() { return Context; } |
| 237 | |
| 238 | enum RegSet { |
| 239 | RegSet_None = 0, |
| 240 | RegSet_CallerSave = 1 << 0, |
| 241 | RegSet_CalleeSave = 1 << 1, |
| 242 | RegSet_StackPointer = 1 << 2, |
| 243 | RegSet_FramePointer = 1 << 3, |
| 244 | RegSet_All = ~RegSet_None |
| 245 | }; |
Andrew Scull | 8072bae | 2015-09-14 16:01:26 -0700 | [diff] [blame] | 246 | using RegSetMask = uint32_t; |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 247 | |
| 248 | virtual llvm::SmallBitVector getRegisterSet(RegSetMask Include, |
| 249 | RegSetMask Exclude) const = 0; |
Jim Stichnoth | c59288b | 2015-11-09 11:38:40 -0800 | [diff] [blame] | 250 | virtual const llvm::SmallBitVector & |
| 251 | getRegistersForVariable(const Variable *Var) const = 0; |
John Porto | bb0a5fe | 2015-09-04 11:23:41 -0700 | [diff] [blame] | 252 | virtual const llvm::SmallBitVector &getAliasesForRegister(SizeT) const = 0; |
| 253 | |
Jim Stichnoth | 70d0a05 | 2014-11-14 15:53:46 -0800 | [diff] [blame] | 254 | void regAlloc(RegAllocKind Kind); |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 255 | |
Qining Lu | aee5fa8 | 2015-08-20 14:59:03 -0700 | [diff] [blame] | 256 | virtual void |
| 257 | makeRandomRegisterPermutation(llvm::SmallVectorImpl<int32_t> &Permutation, |
| 258 | const llvm::SmallBitVector &ExcludeRegisters, |
| 259 | uint64_t Salt) const = 0; |
Jim Stichnoth | e6d2478 | 2014-12-19 05:42:24 -0800 | [diff] [blame] | 260 | |
Andrew Scull | 87f80c1 | 2015-07-20 10:19:16 -0700 | [diff] [blame] | 261 | /// Get the minimum number of clusters required for a jump table to be |
| 262 | /// considered. |
| 263 | virtual SizeT getMinJumpTableSize() const = 0; |
Andrew Scull | 86df4e9 | 2015-07-30 13:54:44 -0700 | [diff] [blame] | 264 | virtual void emitJumpTable(const Cfg *Func, |
| 265 | const InstJumpTable *JumpTable) const = 0; |
Andrew Scull | 87f80c1 | 2015-07-20 10:19:16 -0700 | [diff] [blame] | 266 | |
Jim Stichnoth | 144cdce | 2014-09-22 16:02:59 -0700 | [diff] [blame] | 267 | virtual void emitVariable(const Variable *Var) const = 0; |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 268 | |
Jan Voung | 76bb0be | 2015-05-14 09:26:19 -0700 | [diff] [blame] | 269 | void emitWithoutPrefix(const ConstantRelocatable *CR) const; |
| 270 | void emit(const ConstantRelocatable *CR) const; |
| 271 | virtual const char *getConstantPrefix() const = 0; |
| 272 | |
| 273 | virtual void emit(const ConstantUndef *C) const = 0; |
| 274 | virtual void emit(const ConstantInteger32 *C) const = 0; |
| 275 | virtual void emit(const ConstantInteger64 *C) const = 0; |
| 276 | virtual void emit(const ConstantFloat *C) const = 0; |
| 277 | virtual void emit(const ConstantDouble *C) const = 0; |
| 278 | |
Andrew Scull | 9612d32 | 2015-07-06 14:53:25 -0700 | [diff] [blame] | 279 | /// Performs target-specific argument lowering. |
Matt Wala | 45a0623 | 2014-07-09 16:33:22 -0700 | [diff] [blame] | 280 | virtual void lowerArguments() = 0; |
| 281 | |
Jim Stichnoth | a59ae6f | 2015-05-17 10:11:41 -0700 | [diff] [blame] | 282 | virtual void initNodeForLowering(CfgNode *) {} |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 283 | virtual void addProlog(CfgNode *Node) = 0; |
| 284 | virtual void addEpilog(CfgNode *Node) = 0; |
| 285 | |
Jim Stichnoth | eafb56c | 2015-06-22 10:35:22 -0700 | [diff] [blame] | 286 | virtual ~TargetLowering() = default; |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 287 | |
| 288 | protected: |
Jim Stichnoth | c6ead20 | 2015-02-24 09:30:30 -0800 | [diff] [blame] | 289 | explicit TargetLowering(Cfg *Func); |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 290 | virtual void lowerAlloca(const InstAlloca *Inst) = 0; |
| 291 | virtual void lowerArithmetic(const InstArithmetic *Inst) = 0; |
| 292 | virtual void lowerAssign(const InstAssign *Inst) = 0; |
| 293 | virtual void lowerBr(const InstBr *Inst) = 0; |
| 294 | virtual void lowerCall(const InstCall *Inst) = 0; |
| 295 | virtual void lowerCast(const InstCast *Inst) = 0; |
| 296 | virtual void lowerFcmp(const InstFcmp *Inst) = 0; |
Matt Wala | 4988923 | 2014-07-18 12:45:09 -0700 | [diff] [blame] | 297 | virtual void lowerExtractElement(const InstExtractElement *Inst) = 0; |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 298 | virtual void lowerIcmp(const InstIcmp *Inst) = 0; |
Matt Wala | 4988923 | 2014-07-18 12:45:09 -0700 | [diff] [blame] | 299 | virtual void lowerInsertElement(const InstInsertElement *Inst) = 0; |
Jan Voung | 3bd9f1a | 2014-06-18 10:50:57 -0700 | [diff] [blame] | 300 | virtual void lowerIntrinsicCall(const InstIntrinsicCall *Inst) = 0; |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 301 | virtual void lowerLoad(const InstLoad *Inst) = 0; |
| 302 | virtual void lowerPhi(const InstPhi *Inst) = 0; |
| 303 | virtual void lowerRet(const InstRet *Inst) = 0; |
| 304 | virtual void lowerSelect(const InstSelect *Inst) = 0; |
| 305 | virtual void lowerStore(const InstStore *Inst) = 0; |
| 306 | virtual void lowerSwitch(const InstSwitch *Inst) = 0; |
| 307 | virtual void lowerUnreachable(const InstUnreachable *Inst) = 0; |
Jim Stichnoth | e4f65d8 | 2015-06-17 22:16:02 -0700 | [diff] [blame] | 308 | virtual void lowerOther(const Inst *Instr); |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 309 | |
John Porto | 5e0a8a7 | 2015-11-20 13:50:36 -0800 | [diff] [blame] | 310 | virtual void genTargetHelperCallFor(Inst *Instr) = 0; |
John Porto | f419854 | 2015-11-20 14:17:23 -0800 | [diff] [blame] | 311 | virtual uint32_t getCallStackArgumentsSizeBytes(const InstCall *Instr) = 0; |
John Porto | 5e0a8a7 | 2015-11-20 13:50:36 -0800 | [diff] [blame] | 312 | |
Jim Stichnoth | d97c7df | 2014-06-04 11:57:08 -0700 | [diff] [blame] | 313 | virtual void doAddressOptLoad() {} |
| 314 | virtual void doAddressOptStore() {} |
Jim Stichnoth | ad2989b | 2015-09-15 10:21:42 -0700 | [diff] [blame] | 315 | virtual void doMockBoundsCheck(Operand *) {} |
Qining Lu | aee5fa8 | 2015-08-20 14:59:03 -0700 | [diff] [blame] | 316 | virtual void randomlyInsertNop(float Probability, |
| 317 | RandomNumberGenerator &RNG) = 0; |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 318 | /// This gives the target an opportunity to post-process the lowered expansion |
| 319 | /// before returning. |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 320 | virtual void postLower() {} |
| 321 | |
Jim Stichnoth | 230d410 | 2015-09-25 17:40:32 -0700 | [diff] [blame] | 322 | /// Find (non-SSA) instructions where the Dest variable appears in some source |
| 323 | /// operand, and set the IsDestRedefined flag. This keeps liveness analysis |
| 324 | /// consistent. |
| 325 | void markRedefinitions(); |
Jan Voung | b3401d2 | 2015-05-18 09:38:21 -0700 | [diff] [blame] | 326 | |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 327 | /// Make a pass over the Cfg to determine which variables need stack slots and |
| 328 | /// place them in a sorted list (SortedSpilledVariables). Among those, vars, |
| 329 | /// classify the spill variables as local to the basic block vs global |
| 330 | /// (multi-block) in order to compute the parameters GlobalsSize and |
| 331 | /// SpillAreaSizeBytes (represents locals or general vars if the coalescing of |
| 332 | /// locals is disallowed) along with alignments required for variables in each |
| 333 | /// area. We rely on accurate VMetadata in order to classify a variable as |
| 334 | /// global vs local (otherwise the variable is conservatively global). The |
| 335 | /// in-args should be initialized to 0. |
Andrew Scull | 9612d32 | 2015-07-06 14:53:25 -0700 | [diff] [blame] | 336 | /// |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 337 | /// This is only a pre-pass and the actual stack slot assignment is handled |
| 338 | /// separately. |
Andrew Scull | 9612d32 | 2015-07-06 14:53:25 -0700 | [diff] [blame] | 339 | /// |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 340 | /// There may be target-specific Variable types, which will be handled by |
| 341 | /// TargetVarHook. If the TargetVarHook returns true, then the variable is |
| 342 | /// skipped and not considered with the rest of the spilled variables. |
Jan Voung | 0fa6c5a | 2015-06-01 11:04:04 -0700 | [diff] [blame] | 343 | void getVarStackSlotParams(VarList &SortedSpilledVariables, |
| 344 | llvm::SmallBitVector &RegsUsed, |
| 345 | size_t *GlobalsSize, size_t *SpillAreaSizeBytes, |
| 346 | uint32_t *SpillAreaAlignmentBytes, |
| 347 | uint32_t *LocalsSlotsAlignmentBytes, |
| 348 | std::function<bool(Variable *)> TargetVarHook); |
| 349 | |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 350 | /// Calculate the amount of padding needed to align the local and global areas |
| 351 | /// to the required alignment. This assumes the globals/locals layout used by |
| 352 | /// getVarStackSlotParams and assignVarStackSlots. |
Jan Voung | 0fa6c5a | 2015-06-01 11:04:04 -0700 | [diff] [blame] | 353 | void alignStackSpillAreas(uint32_t SpillAreaStartOffset, |
| 354 | uint32_t SpillAreaAlignmentBytes, |
| 355 | size_t GlobalsSize, |
| 356 | uint32_t LocalsSlotsAlignmentBytes, |
| 357 | uint32_t *SpillAreaPaddingBytes, |
| 358 | uint32_t *LocalsSlotsPaddingBytes); |
| 359 | |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 360 | /// Make a pass through the SortedSpilledVariables and actually assign stack |
| 361 | /// slots. SpillAreaPaddingBytes takes into account stack alignment padding. |
| 362 | /// The SpillArea starts after that amount of padding. This matches the scheme |
| 363 | /// in getVarStackSlotParams, where there may be a separate multi-block global |
| 364 | /// var spill area and a local var spill area. |
Jan Voung | 0fa6c5a | 2015-06-01 11:04:04 -0700 | [diff] [blame] | 365 | void assignVarStackSlots(VarList &SortedSpilledVariables, |
| 366 | size_t SpillAreaPaddingBytes, |
| 367 | size_t SpillAreaSizeBytes, |
| 368 | size_t GlobalsAndSubsequentPaddingSize, |
| 369 | bool UsesFramePointer); |
| 370 | |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 371 | /// Sort the variables in Source based on required alignment. The variables |
| 372 | /// with the largest alignment need are placed in the front of the Dest list. |
Jan Voung | 0fa6c5a | 2015-06-01 11:04:04 -0700 | [diff] [blame] | 373 | void sortVarsByAlignment(VarList &Dest, const VarList &Source) const; |
| 374 | |
Andrew Scull | 9612d32 | 2015-07-06 14:53:25 -0700 | [diff] [blame] | 375 | /// Make a call to an external helper function. |
Jan Voung | b36ad9b | 2015-04-21 17:01:49 -0700 | [diff] [blame] | 376 | InstCall *makeHelperCall(const IceString &Name, Variable *Dest, |
| 377 | SizeT MaxSrcs); |
| 378 | |
Jan Voung | 0fa6c5a | 2015-06-01 11:04:04 -0700 | [diff] [blame] | 379 | void |
| 380 | _bundle_lock(InstBundleLock::Option BundleOption = InstBundleLock::Opt_None) { |
John Porto | 1d937a8 | 2015-12-17 06:19:34 -0800 | [diff] [blame^] | 381 | Context.insert<InstBundleLock>(BundleOption); |
Jan Voung | 0fa6c5a | 2015-06-01 11:04:04 -0700 | [diff] [blame] | 382 | } |
John Porto | 1d937a8 | 2015-12-17 06:19:34 -0800 | [diff] [blame^] | 383 | void _bundle_unlock() { Context.insert<InstBundleUnlock>(); } |
Jim Stichnoth | 230d410 | 2015-09-25 17:40:32 -0700 | [diff] [blame] | 384 | void _set_dest_redefined() { Context.getLastInserted()->setDestRedefined(); } |
Jan Voung | 0fa6c5a | 2015-06-01 11:04:04 -0700 | [diff] [blame] | 385 | |
Andrew Scull | cfa628b | 2015-08-20 14:23:05 -0700 | [diff] [blame] | 386 | bool shouldOptimizeMemIntrins(); |
| 387 | |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 388 | Cfg *Func; |
| 389 | GlobalContext *Ctx; |
Jim Stichnoth | eafb56c | 2015-06-22 10:35:22 -0700 | [diff] [blame] | 390 | bool HasComputedFrame = false; |
| 391 | bool CallsReturnsTwice = false; |
Jim Stichnoth | eafb56c | 2015-06-22 10:35:22 -0700 | [diff] [blame] | 392 | SizeT NextLabelNumber = 0; |
Andrew Scull | 86df4e9 | 2015-07-30 13:54:44 -0700 | [diff] [blame] | 393 | SizeT NextJumpTableNumber = 0; |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 394 | LoweringContext Context; |
Jim Stichnoth | 9738a9e | 2015-02-23 16:39:06 -0800 | [diff] [blame] | 395 | |
Jim Stichnoth | c450879 | 2015-03-01 23:12:55 -0800 | [diff] [blame] | 396 | // Runtime helper function names |
| 397 | const static constexpr char *H_bitcast_16xi1_i16 = "__Sz_bitcast_16xi1_i16"; |
| 398 | const static constexpr char *H_bitcast_8xi1_i8 = "__Sz_bitcast_8xi1_i8"; |
| 399 | const static constexpr char *H_bitcast_i16_16xi1 = "__Sz_bitcast_i16_16xi1"; |
| 400 | const static constexpr char *H_bitcast_i8_8xi1 = "__Sz_bitcast_i8_8xi1"; |
| 401 | const static constexpr char *H_call_ctpop_i32 = "__popcountsi2"; |
| 402 | const static constexpr char *H_call_ctpop_i64 = "__popcountdi2"; |
| 403 | const static constexpr char *H_call_longjmp = "longjmp"; |
| 404 | const static constexpr char *H_call_memcpy = "memcpy"; |
| 405 | const static constexpr char *H_call_memmove = "memmove"; |
| 406 | const static constexpr char *H_call_memset = "memset"; |
| 407 | const static constexpr char *H_call_read_tp = "__nacl_read_tp"; |
| 408 | const static constexpr char *H_call_setjmp = "setjmp"; |
| 409 | const static constexpr char *H_fptosi_f32_i64 = "__Sz_fptosi_f32_i64"; |
| 410 | const static constexpr char *H_fptosi_f64_i64 = "__Sz_fptosi_f64_i64"; |
| 411 | const static constexpr char *H_fptoui_4xi32_f32 = "__Sz_fptoui_4xi32_f32"; |
| 412 | const static constexpr char *H_fptoui_f32_i32 = "__Sz_fptoui_f32_i32"; |
| 413 | const static constexpr char *H_fptoui_f32_i64 = "__Sz_fptoui_f32_i64"; |
| 414 | const static constexpr char *H_fptoui_f64_i32 = "__Sz_fptoui_f64_i32"; |
| 415 | const static constexpr char *H_fptoui_f64_i64 = "__Sz_fptoui_f64_i64"; |
| 416 | const static constexpr char *H_frem_f32 = "fmodf"; |
| 417 | const static constexpr char *H_frem_f64 = "fmod"; |
Jan Voung | 6ec369e | 2015-06-30 11:03:15 -0700 | [diff] [blame] | 418 | const static constexpr char *H_sdiv_i32 = "__divsi3"; |
Jim Stichnoth | c450879 | 2015-03-01 23:12:55 -0800 | [diff] [blame] | 419 | const static constexpr char *H_sdiv_i64 = "__divdi3"; |
| 420 | const static constexpr char *H_sitofp_i64_f32 = "__Sz_sitofp_i64_f32"; |
| 421 | const static constexpr char *H_sitofp_i64_f64 = "__Sz_sitofp_i64_f64"; |
Jan Voung | 6ec369e | 2015-06-30 11:03:15 -0700 | [diff] [blame] | 422 | const static constexpr char *H_srem_i32 = "__modsi3"; |
Jim Stichnoth | c450879 | 2015-03-01 23:12:55 -0800 | [diff] [blame] | 423 | const static constexpr char *H_srem_i64 = "__moddi3"; |
Jan Voung | 6ec369e | 2015-06-30 11:03:15 -0700 | [diff] [blame] | 424 | const static constexpr char *H_udiv_i32 = "__udivsi3"; |
Jim Stichnoth | c450879 | 2015-03-01 23:12:55 -0800 | [diff] [blame] | 425 | const static constexpr char *H_udiv_i64 = "__udivdi3"; |
| 426 | const static constexpr char *H_uitofp_4xi32_4xf32 = "__Sz_uitofp_4xi32_4xf32"; |
| 427 | const static constexpr char *H_uitofp_i32_f32 = "__Sz_uitofp_i32_f32"; |
| 428 | const static constexpr char *H_uitofp_i32_f64 = "__Sz_uitofp_i32_f64"; |
| 429 | const static constexpr char *H_uitofp_i64_f32 = "__Sz_uitofp_i64_f32"; |
| 430 | const static constexpr char *H_uitofp_i64_f64 = "__Sz_uitofp_i64_f64"; |
Jan Voung | 6ec369e | 2015-06-30 11:03:15 -0700 | [diff] [blame] | 431 | const static constexpr char *H_urem_i32 = "__umodsi3"; |
Jim Stichnoth | c450879 | 2015-03-01 23:12:55 -0800 | [diff] [blame] | 432 | const static constexpr char *H_urem_i64 = "__umoddi3"; |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 433 | }; |
| 434 | |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 435 | /// TargetDataLowering is used for "lowering" data including initializers for |
| 436 | /// global variables, and the internal constant pools. It is separated out from |
| 437 | /// TargetLowering because it does not require a Cfg. |
Jan Voung | 72984d8 | 2015-01-29 14:42:38 -0800 | [diff] [blame] | 438 | class TargetDataLowering { |
| 439 | TargetDataLowering() = delete; |
| 440 | TargetDataLowering(const TargetDataLowering &) = delete; |
| 441 | TargetDataLowering &operator=(const TargetDataLowering &) = delete; |
Jim Stichnoth | 7b451a9 | 2014-10-15 14:39:23 -0700 | [diff] [blame] | 442 | |
Jim Stichnoth | de4ca71 | 2014-06-29 08:13:48 -0700 | [diff] [blame] | 443 | public: |
Jim Stichnoth | bbca754 | 2015-02-11 16:08:31 -0800 | [diff] [blame] | 444 | static std::unique_ptr<TargetDataLowering> createLowering(GlobalContext *Ctx); |
Jan Voung | 72984d8 | 2015-01-29 14:42:38 -0800 | [diff] [blame] | 445 | virtual ~TargetDataLowering(); |
Jan Voung | 839c4ce | 2014-07-28 15:19:43 -0700 | [diff] [blame] | 446 | |
John Porto | 8b1a705 | 2015-06-17 13:20:08 -0700 | [diff] [blame] | 447 | virtual void lowerGlobals(const VariableDeclarationList &Vars, |
| 448 | const IceString &SectionSuffix) = 0; |
John Porto | 0f86d03 | 2015-06-15 07:44:27 -0700 | [diff] [blame] | 449 | virtual void lowerConstants() = 0; |
Andrew Scull | 86df4e9 | 2015-07-30 13:54:44 -0700 | [diff] [blame] | 450 | virtual void lowerJumpTables() = 0; |
Jim Stichnoth | de4ca71 | 2014-06-29 08:13:48 -0700 | [diff] [blame] | 451 | |
| 452 | protected: |
John Porto | 8b1a705 | 2015-06-17 13:20:08 -0700 | [diff] [blame] | 453 | void emitGlobal(const VariableDeclaration &Var, |
| 454 | const IceString &SectionSuffix); |
Jan Voung | 58eea4d | 2015-06-15 15:11:56 -0700 | [diff] [blame] | 455 | |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 456 | /// For now, we assume .long is the right directive for emitting 4 byte emit |
| 457 | /// global relocations. However, LLVM MIPS usually uses .4byte instead. |
Andrew Scull | 9612d32 | 2015-07-06 14:53:25 -0700 | [diff] [blame] | 458 | /// Perhaps there is some difference when the location is unaligned. |
John Porto | 8b1a705 | 2015-06-17 13:20:08 -0700 | [diff] [blame] | 459 | static const char *getEmit32Directive() { return ".long"; } |
Jan Voung | 58eea4d | 2015-06-15 15:11:56 -0700 | [diff] [blame] | 460 | |
Jim Stichnoth | c6ead20 | 2015-02-24 09:30:30 -0800 | [diff] [blame] | 461 | explicit TargetDataLowering(GlobalContext *Ctx) : Ctx(Ctx) {} |
Jim Stichnoth | de4ca71 | 2014-06-29 08:13:48 -0700 | [diff] [blame] | 462 | GlobalContext *Ctx; |
Jim Stichnoth | de4ca71 | 2014-06-29 08:13:48 -0700 | [diff] [blame] | 463 | }; |
| 464 | |
Andrew Scull | 57e1268 | 2015-09-16 11:30:19 -0700 | [diff] [blame] | 465 | /// TargetHeaderLowering is used to "lower" the header of an output file. It |
| 466 | /// writes out the target-specific header attributes. E.g., for ARM this writes |
| 467 | /// out the build attributes (float ABI, etc.). |
Jan Voung | fb79284 | 2015-06-11 15:27:50 -0700 | [diff] [blame] | 468 | class TargetHeaderLowering { |
| 469 | TargetHeaderLowering() = delete; |
| 470 | TargetHeaderLowering(const TargetHeaderLowering &) = delete; |
| 471 | TargetHeaderLowering &operator=(const TargetHeaderLowering &) = delete; |
| 472 | |
| 473 | public: |
| 474 | static std::unique_ptr<TargetHeaderLowering> |
| 475 | createLowering(GlobalContext *Ctx); |
| 476 | virtual ~TargetHeaderLowering(); |
| 477 | |
| 478 | virtual void lower() {} |
| 479 | |
| 480 | protected: |
| 481 | explicit TargetHeaderLowering(GlobalContext *Ctx) : Ctx(Ctx) {} |
| 482 | GlobalContext *Ctx; |
| 483 | }; |
| 484 | |
Jim Stichnoth | 5bc2b1d | 2014-05-22 13:38:48 -0700 | [diff] [blame] | 485 | } // end of namespace Ice |
| 486 | |
| 487 | #endif // SUBZERO_SRC_ICETARGETLOWERING_H |