2015-02-02 00:15:07 +08:00
|
|
|
//===-- X86TargetFrameLowering.h - Define frame lowering for X86 -*- C++ -*-==//
|
|
|
|
|
//
|
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
|
//
|
|
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
|
// License. See LICENSE.TXT for details.
|
|
|
|
|
//
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
//
|
|
|
|
|
// This class implements X86-specific bits of TargetFrameLowering class.
|
|
|
|
|
//
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
|
|
#ifndef LLVM_LIB_TARGET_X86_X86FRAMELOWERING_H
|
|
|
|
|
#define LLVM_LIB_TARGET_X86_X86FRAMELOWERING_H
|
|
|
|
|
|
|
|
|
|
#include "llvm/Target/TargetFrameLowering.h"
|
|
|
|
|
|
|
|
|
|
namespace llvm {
|
|
|
|
|
|
2015-06-19 04:22:12 +08:00
|
|
|
class MachineInstrBuilder;
|
2015-06-19 02:03:25 +08:00
|
|
|
class MCCFIInstruction;
|
2015-06-18 05:50:02 +08:00
|
|
|
class X86Subtarget;
|
|
|
|
|
class X86RegisterInfo;
|
|
|
|
|
|
2015-02-02 00:15:07 +08:00
|
|
|
class X86FrameLowering : public TargetFrameLowering {
|
|
|
|
|
public:
|
2015-06-18 05:50:02 +08:00
|
|
|
X86FrameLowering(const X86Subtarget &STI, unsigned StackAlignOverride);
|
|
|
|
|
|
|
|
|
|
// Cached subtarget predicates.
|
|
|
|
|
|
|
|
|
|
const X86Subtarget &STI;
|
|
|
|
|
const TargetInstrInfo &TII;
|
2015-06-19 04:32:02 +08:00
|
|
|
const X86RegisterInfo *TRI;
|
2015-06-18 05:50:02 +08:00
|
|
|
|
|
|
|
|
unsigned SlotSize;
|
|
|
|
|
|
|
|
|
|
/// Is64Bit implies that x86_64 instructions are available.
|
|
|
|
|
bool Is64Bit;
|
|
|
|
|
|
|
|
|
|
bool IsLP64;
|
|
|
|
|
|
|
|
|
|
/// True if the 64-bit frame or stack pointer should be used. True for most
|
|
|
|
|
/// 64-bit targets with the exception of x32. If this is false, 32-bit
|
|
|
|
|
/// instruction operands should be used to manipulate StackPtr and FramePtr.
|
|
|
|
|
bool Uses64BitFramePtr;
|
2015-02-02 00:15:07 +08:00
|
|
|
|
2015-06-19 02:03:25 +08:00
|
|
|
unsigned StackPtr;
|
|
|
|
|
|
2015-02-02 00:15:07 +08:00
|
|
|
/// Emit a call to the target's stack probe function. This is required for all
|
|
|
|
|
/// large stack allocations on Windows. The caller is required to materialize
|
|
|
|
|
/// the number of bytes to probe in RAX/EAX.
|
2015-06-18 05:50:02 +08:00
|
|
|
void emitStackProbeCall(MachineFunction &MF, MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator MBBI, DebugLoc DL) const;
|
2015-02-02 00:15:07 +08:00
|
|
|
|
|
|
|
|
void emitCalleeSavedFrameMoves(MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator MBBI,
|
|
|
|
|
DebugLoc DL) const;
|
|
|
|
|
|
|
|
|
|
/// emitProlog/emitEpilog - These methods insert prolog and epilog code into
|
|
|
|
|
/// the function.
|
[ShrinkWrap] Add (a simplified version) of shrink-wrapping.
This patch introduces a new pass that computes the safe point to insert the
prologue and epilogue of the function.
The interest is to find safe points that are cheaper than the entry and exits
blocks.
As an example and to avoid regressions to be introduce, this patch also
implements the required bits to enable the shrink-wrapping pass for AArch64.
** Context **
Currently we insert the prologue and epilogue of the method/function in the
entry and exits blocks. Although this is correct, we can do a better job when
those are not immediately required and insert them at less frequently executed
places.
The job of the shrink-wrapping pass is to identify such places.
** Motivating example **
Let us consider the following function that perform a call only in one branch of
a if:
define i32 @f(i32 %a, i32 %b) {
%tmp = alloca i32, align 4
%tmp2 = icmp slt i32 %a, %b
br i1 %tmp2, label %true, label %false
true:
store i32 %a, i32* %tmp, align 4
%tmp4 = call i32 @doSomething(i32 0, i32* %tmp)
br label %false
false:
%tmp.0 = phi i32 [ %tmp4, %true ], [ %a, %0 ]
ret i32 %tmp.0
}
On AArch64 this code generates (removing the cfi directives to ease
readabilities):
_f: ; @f
; BB#0:
stp x29, x30, [sp, #-16]!
mov x29, sp
sub sp, sp, #16 ; =16
cmp w0, w1
b.ge LBB0_2
; BB#1: ; %true
stur w0, [x29, #-4]
sub x1, x29, #4 ; =4
mov w0, wzr
bl _doSomething
LBB0_2: ; %false
mov sp, x29
ldp x29, x30, [sp], #16
ret
With shrink-wrapping we could generate:
_f: ; @f
; BB#0:
cmp w0, w1
b.ge LBB0_2
; BB#1: ; %true
stp x29, x30, [sp, #-16]!
mov x29, sp
sub sp, sp, #16 ; =16
stur w0, [x29, #-4]
sub x1, x29, #4 ; =4
mov w0, wzr
bl _doSomething
add sp, x29, #16 ; =16
ldp x29, x30, [sp], #16
LBB0_2: ; %false
ret
Therefore, we would pay the overhead of setting up/destroying the frame only if
we actually do the call.
** Proposed Solution **
This patch introduces a new machine pass that perform the shrink-wrapping
analysis (See the comments at the beginning of ShrinkWrap.cpp for more details).
It then stores the safe save and restore point into the MachineFrameInfo
attached to the MachineFunction.
This information is then used by the PrologEpilogInserter (PEI) to place the
related code at the right place. This pass runs right before the PEI.
Unlike the original paper of Chow from PLDI’88, this implementation of
shrink-wrapping does not use expensive data-flow analysis and does not need hack
to properly avoid frequently executed point. Instead, it relies on dominance and
loop properties.
The pass is off by default and each target can opt-in by setting the
EnableShrinkWrap boolean to true in their derived class of TargetPassConfig.
This setting can also be overwritten on the command line by using
-enable-shrink-wrap.
Before you try out the pass for your target, make sure you properly fix your
emitProlog/emitEpilog/adjustForXXX method to cope with basic blocks that are not
necessarily the entry block.
** Design Decisions **
1. ShrinkWrap is its own pass right now. It could frankly be merged into PEI but
for debugging and clarity I thought it was best to have its own file.
2. Right now, we only support one save point and one restore point. At some
point we can expand this to several save point and restore point, the impacted
component would then be:
- The pass itself: New algorithm needed.
- MachineFrameInfo: Hold a list or set of Save/Restore point instead of one
pointer.
- PEI: Should loop over the save point and restore point.
Anyhow, at least for this first iteration, I do not believe this is interesting
to support the complex cases. We should revisit that when we motivating
examples.
Differential Revision: http://reviews.llvm.org/D9210
<rdar://problem/3201744>
llvm-svn: 236507
2015-05-06 01:38:16 +08:00
|
|
|
void emitPrologue(MachineFunction &MF, MachineBasicBlock &MBB) const override;
|
2015-02-02 00:15:07 +08:00
|
|
|
void emitEpilogue(MachineFunction &MF, MachineBasicBlock &MBB) const override;
|
|
|
|
|
|
[ShrinkWrap] Add (a simplified version) of shrink-wrapping.
This patch introduces a new pass that computes the safe point to insert the
prologue and epilogue of the function.
The interest is to find safe points that are cheaper than the entry and exits
blocks.
As an example and to avoid regressions to be introduce, this patch also
implements the required bits to enable the shrink-wrapping pass for AArch64.
** Context **
Currently we insert the prologue and epilogue of the method/function in the
entry and exits blocks. Although this is correct, we can do a better job when
those are not immediately required and insert them at less frequently executed
places.
The job of the shrink-wrapping pass is to identify such places.
** Motivating example **
Let us consider the following function that perform a call only in one branch of
a if:
define i32 @f(i32 %a, i32 %b) {
%tmp = alloca i32, align 4
%tmp2 = icmp slt i32 %a, %b
br i1 %tmp2, label %true, label %false
true:
store i32 %a, i32* %tmp, align 4
%tmp4 = call i32 @doSomething(i32 0, i32* %tmp)
br label %false
false:
%tmp.0 = phi i32 [ %tmp4, %true ], [ %a, %0 ]
ret i32 %tmp.0
}
On AArch64 this code generates (removing the cfi directives to ease
readabilities):
_f: ; @f
; BB#0:
stp x29, x30, [sp, #-16]!
mov x29, sp
sub sp, sp, #16 ; =16
cmp w0, w1
b.ge LBB0_2
; BB#1: ; %true
stur w0, [x29, #-4]
sub x1, x29, #4 ; =4
mov w0, wzr
bl _doSomething
LBB0_2: ; %false
mov sp, x29
ldp x29, x30, [sp], #16
ret
With shrink-wrapping we could generate:
_f: ; @f
; BB#0:
cmp w0, w1
b.ge LBB0_2
; BB#1: ; %true
stp x29, x30, [sp, #-16]!
mov x29, sp
sub sp, sp, #16 ; =16
stur w0, [x29, #-4]
sub x1, x29, #4 ; =4
mov w0, wzr
bl _doSomething
add sp, x29, #16 ; =16
ldp x29, x30, [sp], #16
LBB0_2: ; %false
ret
Therefore, we would pay the overhead of setting up/destroying the frame only if
we actually do the call.
** Proposed Solution **
This patch introduces a new machine pass that perform the shrink-wrapping
analysis (See the comments at the beginning of ShrinkWrap.cpp for more details).
It then stores the safe save and restore point into the MachineFrameInfo
attached to the MachineFunction.
This information is then used by the PrologEpilogInserter (PEI) to place the
related code at the right place. This pass runs right before the PEI.
Unlike the original paper of Chow from PLDI’88, this implementation of
shrink-wrapping does not use expensive data-flow analysis and does not need hack
to properly avoid frequently executed point. Instead, it relies on dominance and
loop properties.
The pass is off by default and each target can opt-in by setting the
EnableShrinkWrap boolean to true in their derived class of TargetPassConfig.
This setting can also be overwritten on the command line by using
-enable-shrink-wrap.
Before you try out the pass for your target, make sure you properly fix your
emitProlog/emitEpilog/adjustForXXX method to cope with basic blocks that are not
necessarily the entry block.
** Design Decisions **
1. ShrinkWrap is its own pass right now. It could frankly be merged into PEI but
for debugging and clarity I thought it was best to have its own file.
2. Right now, we only support one save point and one restore point. At some
point we can expand this to several save point and restore point, the impacted
component would then be:
- The pass itself: New algorithm needed.
- MachineFrameInfo: Hold a list or set of Save/Restore point instead of one
pointer.
- PEI: Should loop over the save point and restore point.
Anyhow, at least for this first iteration, I do not believe this is interesting
to support the complex cases. We should revisit that when we motivating
examples.
Differential Revision: http://reviews.llvm.org/D9210
<rdar://problem/3201744>
llvm-svn: 236507
2015-05-06 01:38:16 +08:00
|
|
|
void adjustForSegmentedStacks(MachineFunction &MF,
|
|
|
|
|
MachineBasicBlock &PrologueMBB) const override;
|
2015-02-02 00:15:07 +08:00
|
|
|
|
[ShrinkWrap] Add (a simplified version) of shrink-wrapping.
This patch introduces a new pass that computes the safe point to insert the
prologue and epilogue of the function.
The interest is to find safe points that are cheaper than the entry and exits
blocks.
As an example and to avoid regressions to be introduce, this patch also
implements the required bits to enable the shrink-wrapping pass for AArch64.
** Context **
Currently we insert the prologue and epilogue of the method/function in the
entry and exits blocks. Although this is correct, we can do a better job when
those are not immediately required and insert them at less frequently executed
places.
The job of the shrink-wrapping pass is to identify such places.
** Motivating example **
Let us consider the following function that perform a call only in one branch of
a if:
define i32 @f(i32 %a, i32 %b) {
%tmp = alloca i32, align 4
%tmp2 = icmp slt i32 %a, %b
br i1 %tmp2, label %true, label %false
true:
store i32 %a, i32* %tmp, align 4
%tmp4 = call i32 @doSomething(i32 0, i32* %tmp)
br label %false
false:
%tmp.0 = phi i32 [ %tmp4, %true ], [ %a, %0 ]
ret i32 %tmp.0
}
On AArch64 this code generates (removing the cfi directives to ease
readabilities):
_f: ; @f
; BB#0:
stp x29, x30, [sp, #-16]!
mov x29, sp
sub sp, sp, #16 ; =16
cmp w0, w1
b.ge LBB0_2
; BB#1: ; %true
stur w0, [x29, #-4]
sub x1, x29, #4 ; =4
mov w0, wzr
bl _doSomething
LBB0_2: ; %false
mov sp, x29
ldp x29, x30, [sp], #16
ret
With shrink-wrapping we could generate:
_f: ; @f
; BB#0:
cmp w0, w1
b.ge LBB0_2
; BB#1: ; %true
stp x29, x30, [sp, #-16]!
mov x29, sp
sub sp, sp, #16 ; =16
stur w0, [x29, #-4]
sub x1, x29, #4 ; =4
mov w0, wzr
bl _doSomething
add sp, x29, #16 ; =16
ldp x29, x30, [sp], #16
LBB0_2: ; %false
ret
Therefore, we would pay the overhead of setting up/destroying the frame only if
we actually do the call.
** Proposed Solution **
This patch introduces a new machine pass that perform the shrink-wrapping
analysis (See the comments at the beginning of ShrinkWrap.cpp for more details).
It then stores the safe save and restore point into the MachineFrameInfo
attached to the MachineFunction.
This information is then used by the PrologEpilogInserter (PEI) to place the
related code at the right place. This pass runs right before the PEI.
Unlike the original paper of Chow from PLDI’88, this implementation of
shrink-wrapping does not use expensive data-flow analysis and does not need hack
to properly avoid frequently executed point. Instead, it relies on dominance and
loop properties.
The pass is off by default and each target can opt-in by setting the
EnableShrinkWrap boolean to true in their derived class of TargetPassConfig.
This setting can also be overwritten on the command line by using
-enable-shrink-wrap.
Before you try out the pass for your target, make sure you properly fix your
emitProlog/emitEpilog/adjustForXXX method to cope with basic blocks that are not
necessarily the entry block.
** Design Decisions **
1. ShrinkWrap is its own pass right now. It could frankly be merged into PEI but
for debugging and clarity I thought it was best to have its own file.
2. Right now, we only support one save point and one restore point. At some
point we can expand this to several save point and restore point, the impacted
component would then be:
- The pass itself: New algorithm needed.
- MachineFrameInfo: Hold a list or set of Save/Restore point instead of one
pointer.
- PEI: Should loop over the save point and restore point.
Anyhow, at least for this first iteration, I do not believe this is interesting
to support the complex cases. We should revisit that when we motivating
examples.
Differential Revision: http://reviews.llvm.org/D9210
<rdar://problem/3201744>
llvm-svn: 236507
2015-05-06 01:38:16 +08:00
|
|
|
void adjustForHiPEPrologue(MachineFunction &MF,
|
|
|
|
|
MachineBasicBlock &PrologueMBB) const override;
|
2015-02-02 00:15:07 +08:00
|
|
|
|
2015-07-15 01:17:13 +08:00
|
|
|
void determineCalleeSaves(MachineFunction &MF, BitVector &SavedRegs,
|
|
|
|
|
RegScavenger *RS = nullptr) const override;
|
2015-02-02 00:15:07 +08:00
|
|
|
|
|
|
|
|
bool
|
|
|
|
|
assignCalleeSavedSpillSlots(MachineFunction &MF,
|
|
|
|
|
const TargetRegisterInfo *TRI,
|
|
|
|
|
std::vector<CalleeSavedInfo> &CSI) const override;
|
|
|
|
|
|
|
|
|
|
bool spillCalleeSavedRegisters(MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator MI,
|
|
|
|
|
const std::vector<CalleeSavedInfo> &CSI,
|
|
|
|
|
const TargetRegisterInfo *TRI) const override;
|
|
|
|
|
|
|
|
|
|
bool restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator MI,
|
|
|
|
|
const std::vector<CalleeSavedInfo> &CSI,
|
|
|
|
|
const TargetRegisterInfo *TRI) const override;
|
|
|
|
|
|
|
|
|
|
bool hasFP(const MachineFunction &MF) const override;
|
|
|
|
|
bool hasReservedCallFrame(const MachineFunction &MF) const override;
|
2015-02-02 00:56:04 +08:00
|
|
|
bool canSimplifyCallFramePseudos(const MachineFunction &MF) const override;
|
|
|
|
|
bool needsFrameIndexResolution(const MachineFunction &MF) const override;
|
2015-02-02 00:15:07 +08:00
|
|
|
|
|
|
|
|
int getFrameIndexReference(const MachineFunction &MF, int FI,
|
|
|
|
|
unsigned &FrameReg) const override;
|
|
|
|
|
|
|
|
|
|
int getFrameIndexReferenceFromSP(const MachineFunction &MF, int FI,
|
|
|
|
|
unsigned &FrameReg) const override;
|
|
|
|
|
|
|
|
|
|
void eliminateCallFramePseudoInstr(MachineFunction &MF,
|
|
|
|
|
MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator MI) const override;
|
|
|
|
|
|
2015-05-23 02:10:47 +08:00
|
|
|
/// Check the instruction before/after the passed instruction. If
|
|
|
|
|
/// it is an ADD/SUB/LEA instruction it is deleted argument and the
|
|
|
|
|
/// stack adjustment is returned as a positive value for ADD/LEA and
|
|
|
|
|
/// a negative for SUB.
|
2015-06-18 05:50:02 +08:00
|
|
|
int mergeSPUpdates(MachineBasicBlock &MBB, MachineBasicBlock::iterator &MBBI,
|
2015-06-19 02:03:25 +08:00
|
|
|
bool doMergeWithPrevious) const;
|
2015-05-23 02:10:47 +08:00
|
|
|
|
|
|
|
|
/// Emit a series of instructions to increment / decrement the stack
|
|
|
|
|
/// pointer by a constant value.
|
2015-06-18 05:50:02 +08:00
|
|
|
void emitSPUpdate(MachineBasicBlock &MBB, MachineBasicBlock::iterator &MBBI,
|
2015-06-19 04:22:12 +08:00
|
|
|
int64_t NumBytes, bool InEpilogue) const;
|
2015-05-23 02:10:47 +08:00
|
|
|
|
2015-05-27 14:28:41 +08:00
|
|
|
/// Check that LEA can be used on SP in an epilogue sequence for \p MF.
|
|
|
|
|
bool canUseLEAForSPInEpilogue(const MachineFunction &MF) const;
|
|
|
|
|
|
|
|
|
|
/// Check whether or not the given \p MBB can be used as a epilogue
|
|
|
|
|
/// for the target.
|
|
|
|
|
/// The epilogue will be inserted before the first terminator of that block.
|
|
|
|
|
/// This method is used by the shrink-wrapping pass to decide if
|
|
|
|
|
/// \p MBB will be correctly handled by the target.
|
|
|
|
|
bool canUseAsEpilogue(const MachineBasicBlock &MBB) const override;
|
2015-05-23 02:10:47 +08:00
|
|
|
|
2015-02-02 00:15:07 +08:00
|
|
|
private:
|
|
|
|
|
/// convertArgMovsToPushes - This method tries to convert a call sequence
|
|
|
|
|
/// that uses sub and mov instructions to put the argument onto the stack
|
|
|
|
|
/// into a series of pushes.
|
|
|
|
|
/// Returns true if the transformation succeeded, false if not.
|
|
|
|
|
bool convertArgMovsToPushes(MachineFunction &MF,
|
|
|
|
|
MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator I,
|
|
|
|
|
uint64_t Amount) const;
|
2015-06-18 05:50:02 +08:00
|
|
|
|
|
|
|
|
uint64_t calculateMaxStackAlign(const MachineFunction &MF) const;
|
2015-06-19 02:03:25 +08:00
|
|
|
|
|
|
|
|
/// Wraps up getting a CFI index and building a MachineInstr for it.
|
|
|
|
|
void BuildCFI(MachineBasicBlock &MBB, MachineBasicBlock::iterator MBBI,
|
|
|
|
|
DebugLoc DL, MCCFIInstruction CFIInst) const;
|
|
|
|
|
|
|
|
|
|
/// Aligns the stack pointer by ANDing it with -MaxAlign.
|
|
|
|
|
void BuildStackAlignAND(MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator MBBI, DebugLoc DL,
|
|
|
|
|
uint64_t MaxAlign) const;
|
2015-06-19 04:22:12 +08:00
|
|
|
|
2015-08-11 16:48:48 +08:00
|
|
|
/// Make small positive stack adjustments using POPs.
|
|
|
|
|
bool adjustStackWithPops(MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator MBBI, DebugLoc DL,
|
|
|
|
|
int Offset) const;
|
|
|
|
|
|
2015-06-19 04:22:12 +08:00
|
|
|
/// Adjusts the stack pointer using LEA, SUB, or ADD.
|
|
|
|
|
MachineInstrBuilder BuildStackAdjustment(MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator MBBI,
|
|
|
|
|
DebugLoc DL, int64_t Offset,
|
|
|
|
|
bool InEpilogue) const;
|
2015-09-09 06:44:41 +08:00
|
|
|
|
|
|
|
|
/// Sets up EBP and optionally ESI based on the incoming EBP value. Only
|
|
|
|
|
/// needed for 32-bit. Used in funclet prologues and at catchret destinations.
|
|
|
|
|
MachineBasicBlock::iterator
|
|
|
|
|
restoreWin32EHFrameAndBasePtr(MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator MBBI,
|
|
|
|
|
DebugLoc DL) const;
|
2015-02-02 00:15:07 +08:00
|
|
|
};
|
|
|
|
|
|
2015-06-23 17:49:53 +08:00
|
|
|
} // End llvm namespace
|
2015-02-02 00:15:07 +08:00
|
|
|
|
|
|
|
|
#endif
|