2017-09-21 05:35:51 +08:00
|
|
|
//===- ARMTargetFrameLowering.h - Define frame lowering for ARM -*- C++ -*-===//
|
2006-08-16 22:43:33 +08:00
|
|
|
//
|
2019-01-19 16:50:56 +08:00
|
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
|
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
|
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
2006-08-16 22:43:33 +08:00
|
|
|
//
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
2014-08-14 00:26:38 +08:00
|
|
|
#ifndef LLVM_LIB_TARGET_ARM_ARMFRAMELOWERING_H
|
|
|
|
|
#define LLVM_LIB_TARGET_ARM_ARMFRAMELOWERING_H
|
2006-08-16 22:43:33 +08:00
|
|
|
|
2017-09-21 05:35:51 +08:00
|
|
|
#include "llvm/CodeGen/MachineBasicBlock.h"
|
2017-11-04 06:32:11 +08:00
|
|
|
#include "llvm/CodeGen/TargetFrameLowering.h"
|
2017-09-21 05:35:51 +08:00
|
|
|
#include <vector>
|
2006-08-16 22:43:33 +08:00
|
|
|
|
|
|
|
|
namespace llvm {
|
2017-09-21 05:35:51 +08:00
|
|
|
|
|
|
|
|
class ARMSubtarget;
|
|
|
|
|
class CalleeSavedInfo;
|
|
|
|
|
class MachineFunction;
|
2006-08-16 22:43:33 +08:00
|
|
|
|
2011-01-10 20:39:04 +08:00
|
|
|
class ARMFrameLowering : public TargetFrameLowering {
|
2010-11-15 08:06:54 +08:00
|
|
|
protected:
|
|
|
|
|
const ARMSubtarget &STI;
|
|
|
|
|
|
2006-08-16 22:43:33 +08:00
|
|
|
public:
|
2014-06-27 03:29:59 +08:00
|
|
|
explicit ARMFrameLowering(const ARMSubtarget &sti);
|
2010-11-15 08:06:54 +08:00
|
|
|
|
|
|
|
|
/// 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;
|
2014-03-10 10:09:33 +08:00
|
|
|
void emitEpilogue(MachineFunction &MF, MachineBasicBlock &MBB) const override;
|
2010-11-19 05:19:35 +08:00
|
|
|
|
2010-11-28 07:05:03 +08:00
|
|
|
bool spillCalleeSavedRegisters(MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator MI,
|
|
|
|
|
const std::vector<CalleeSavedInfo> &CSI,
|
2014-03-10 10:09:33 +08:00
|
|
|
const TargetRegisterInfo *TRI) const override;
|
2010-11-28 07:05:03 +08:00
|
|
|
|
|
|
|
|
bool restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
|
2014-03-10 10:09:33 +08:00
|
|
|
MachineBasicBlock::iterator MI,
|
2017-08-11 00:17:32 +08:00
|
|
|
std::vector<CalleeSavedInfo> &CSI,
|
2014-03-10 10:09:33 +08:00
|
|
|
const TargetRegisterInfo *TRI) const override;
|
2010-11-28 07:05:03 +08:00
|
|
|
|
2019-01-14 18:55:55 +08:00
|
|
|
bool keepFramePointer(const MachineFunction &MF) const override;
|
2015-05-23 09:14:08 +08:00
|
|
|
|
2018-04-07 18:57:03 +08:00
|
|
|
bool enableCalleeSaveSkip(const MachineFunction &MF) const override;
|
|
|
|
|
|
2014-03-10 10:09:33 +08:00
|
|
|
bool hasFP(const MachineFunction &MF) const override;
|
|
|
|
|
bool hasReservedCallFrame(const MachineFunction &MF) const override;
|
|
|
|
|
bool canSimplifyCallFramePseudos(const MachineFunction &MF) const override;
|
2010-11-20 23:59:32 +08:00
|
|
|
int getFrameIndexReference(const MachineFunction &MF, int FI,
|
2014-03-10 10:09:33 +08:00
|
|
|
unsigned &FrameReg) const override;
|
|
|
|
|
int ResolveFrameIndexReference(const MachineFunction &MF, int FI,
|
2010-11-20 23:59:32 +08:00
|
|
|
unsigned &FrameReg, int SPAdj) const;
|
|
|
|
|
|
2015-07-15 01:17:13 +08:00
|
|
|
void determineCalleeSaves(MachineFunction &MF, BitVector &SavedRegs,
|
|
|
|
|
RegScavenger *RS) const override;
|
2010-11-28 07:05:25 +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 adjustForSegmentedStacks(MachineFunction &MF,
|
|
|
|
|
MachineBasicBlock &MBB) const override;
|
2014-04-03 00:10:33 +08:00
|
|
|
|
2015-11-18 08:40:54 +08:00
|
|
|
/// Returns true if the target will correctly handle shrink wrapping.
|
|
|
|
|
bool enableShrinkWrapping(const MachineFunction &MF) const override {
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
2017-09-21 05:35:51 +08:00
|
|
|
private:
|
2010-11-28 07:05:03 +08:00
|
|
|
void emitPushInst(MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
|
2010-12-10 02:31:13 +08:00
|
|
|
const std::vector<CalleeSavedInfo> &CSI, unsigned StmOpc,
|
|
|
|
|
unsigned StrOpc, bool NoGap,
|
2011-12-23 08:36:18 +08:00
|
|
|
bool(*Func)(unsigned, bool), unsigned NumAlignedDPRCS2Regs,
|
2011-03-06 02:43:32 +08:00
|
|
|
unsigned MIFlags = 0) const;
|
2010-12-08 07:08:38 +08:00
|
|
|
void emitPopInst(MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
|
2017-08-11 00:17:32 +08:00
|
|
|
std::vector<CalleeSavedInfo> &CSI, unsigned LdmOpc,
|
2010-12-10 02:31:13 +08:00
|
|
|
unsigned LdrOpc, bool isVarArg, bool NoGap,
|
2011-12-23 08:36:18 +08:00
|
|
|
bool(*Func)(unsigned, bool),
|
|
|
|
|
unsigned NumAlignedDPRCS2Regs) const;
|
2013-02-22 04:05:00 +08:00
|
|
|
|
2016-04-01 02:33:38 +08:00
|
|
|
MachineBasicBlock::iterator
|
2014-03-10 10:09:33 +08:00
|
|
|
eliminateCallFramePseudoInstr(MachineFunction &MF,
|
|
|
|
|
MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator MI) const override;
|
2006-08-16 22:43:33 +08:00
|
|
|
};
|
|
|
|
|
|
2017-09-21 05:35:51 +08:00
|
|
|
} // end namespace llvm
|
2006-08-16 22:43:33 +08:00
|
|
|
|
2017-09-21 05:35:51 +08:00
|
|
|
#endif // LLVM_LIB_TARGET_ARM_ARMFRAMELOWERING_H
|