2017-07-27 01:20:35 +02:00
|
|
|
//==- HexagonFrameLowering.h - Define frame lowering for Hexagon -*- C++ -*-==//
|
2011-12-12 22:14:40 +01:00
|
|
|
//
|
2019-01-19 09:50:56 +01: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
|
2011-12-12 22:14:40 +01:00
|
|
|
//
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
2014-08-13 18:26:38 +02:00
|
|
|
#ifndef LLVM_LIB_TARGET_HEXAGON_HEXAGONFRAMELOWERING_H
|
|
|
|
|
#define LLVM_LIB_TARGET_HEXAGON_HEXAGONFRAMELOWERING_H
|
2011-12-12 22:14:40 +01:00
|
|
|
|
|
|
|
|
#include "Hexagon.h"
|
2016-02-12 23:53:35 +01:00
|
|
|
#include "HexagonBlockRanges.h"
|
2016-12-16 02:00:40 +01:00
|
|
|
#include "llvm/ADT/STLExtras.h"
|
|
|
|
|
#include "llvm/CodeGen/MachineBasicBlock.h"
|
|
|
|
|
#include "llvm/CodeGen/MachineFrameInfo.h"
|
2017-11-03 23:32:11 +01:00
|
|
|
#include "llvm/CodeGen/TargetFrameLowering.h"
|
2016-12-16 02:00:40 +01:00
|
|
|
#include <vector>
|
2011-12-12 22:14:40 +01:00
|
|
|
|
|
|
|
|
namespace llvm {
|
|
|
|
|
|
2017-07-27 01:20:35 +02:00
|
|
|
class BitVector;
|
2015-04-22 18:43:53 +02:00
|
|
|
class HexagonInstrInfo;
|
2015-04-23 18:05:39 +02:00
|
|
|
class HexagonRegisterInfo;
|
2017-07-27 01:20:35 +02:00
|
|
|
class MachineFunction;
|
|
|
|
|
class MachineInstr;
|
|
|
|
|
class MachineRegisterInfo;
|
|
|
|
|
class TargetRegisterClass;
|
2015-04-22 18:43:53 +02:00
|
|
|
|
2011-12-12 22:14:40 +01:00
|
|
|
class HexagonFrameLowering : public TargetFrameLowering {
|
|
|
|
|
public:
|
Add support for Linux/Musl ABI
Differential revision: https://reviews.llvm.org/D72701
The patch adds a new option ABI for Hexagon. It primary deals with
the way variable arguments are passed and is use in the Hexagon Linux Musl
environment.
If a callee function has a variable argument list, it must perform the
following operations to set up its function prologue:
1. Determine the number of registers which could have been used for passing
unnamed arguments. This can be calculated by counting the number of
registers used for passing named arguments. For example, if the callee
function is as follows:
int foo(int a, ...){ ... }
... then register R0 is used to access the argument ' a '. The registers
available for passing unnamed arguments are R1, R2, R3, R4, and R5.
2. Determine the number and size of the named arguments on the stack.
3. If the callee has named arguments on the stack, it should copy all of these
arguments to a location below the current position on the stack, and the
difference should be the size of the register-saved area plus padding
(if any is necessary).
The register-saved area constitutes all the registers that could have
been used to pass unnamed arguments. If the number of registers forming
the register-saved area is odd, it requires 4 bytes of padding; if the
number is even, no padding is required. This is done to ensure an 8-byte
alignment on the stack. For example, if the callee is as follows:
int foo(int a, ...){ ... }
... then the named arguments should be copied to the following location:
current_position - 5 (for R1-R5) * 4 (bytes) - 4 (bytes of padding)
If the callee is as follows:
int foo(int a, int b, ...){ ... }
... then the named arguments should be copied to the following location:
current_position - 4 (for R2-R5) * 4 (bytes) - 0 (bytes of padding)
4. After any named arguments have been copied, copy all the registers that
could have been used to pass unnamed arguments on the stack. If the number
of registers is odd, leave 4 bytes of padding and then start copying them
on the stack; if the number is even, no padding is required. This
constitutes the register-saved area. If padding is required, ensure
that the start location of padding is 8-byte aligned. If no padding is
required, ensure that the start location of the on-stack copy of the
first register which might have a variable argument is 8-byte aligned.
5. Decrement the stack pointer by the size of register saved area plus the
padding. For example, if the callee is as follows:
int foo(int a, ...){ ... } ;
... then the decrement value should be the following:
5 (for R1-R5) * 4 (bytes) + 4 (bytes of padding) = 24 bytes
The decrement should be performed before the allocframe instruction.
Increment the stack-pointer back by the same amount before returning
from the function.
2019-12-27 20:03:01 +01:00
|
|
|
// First register which could possibly hold a variable argument.
|
|
|
|
|
int FirstVarArgSavedReg;
|
2015-04-22 18:43:53 +02:00
|
|
|
explicit HexagonFrameLowering()
|
[Alignment][NFC] Deprecate Align::None()
Summary:
This is a follow up on https://reviews.llvm.org/D71473#inline-647262.
There's a caveat here that `Align(1)` relies on the compiler understanding of `Log2_64` implementation to produce good code. One could use `Align()` as a replacement but I believe it is less clear that the alignment is one in that case.
Reviewers: xbolva00, courbet, bollu
Subscribers: arsenm, dylanmckay, sdardis, nemanjai, jvesely, nhaehnle, hiraditya, kbarton, jrtc27, atanasyan, jsji, Jim, kerbowa, cfe-commits, llvm-commits
Tags: #clang, #llvm
Differential Revision: https://reviews.llvm.org/D73099
2020-01-21 15:00:04 +01:00
|
|
|
: TargetFrameLowering(StackGrowsDown, Align(8), 0, Align(1), true) {}
|
2011-12-12 22:14:40 +01:00
|
|
|
|
2015-04-23 18:05:39 +02:00
|
|
|
// All of the prolog/epilog functionality, including saving and restoring
|
|
|
|
|
// callee-saved registers is handled in emitPrologue. This is to have the
|
|
|
|
|
// logic for shrink-wrapping in one place.
|
[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-05 19:38:16 +02:00
|
|
|
void emitPrologue(MachineFunction &MF, MachineBasicBlock &MBB) const
|
|
|
|
|
override;
|
2015-04-23 18:05:39 +02:00
|
|
|
void emitEpilogue(MachineFunction &MF, MachineBasicBlock &MBB) const
|
|
|
|
|
override {}
|
2016-12-16 02:00:40 +01:00
|
|
|
|
2018-11-09 19:16:24 +01:00
|
|
|
bool enableCalleeSaveSkip(const MachineFunction &MF) const override;
|
|
|
|
|
|
2015-04-23 18:05:39 +02:00
|
|
|
bool spillCalleeSavedRegisters(MachineBasicBlock &MBB,
|
2020-02-08 12:14:37 +01:00
|
|
|
MachineBasicBlock::iterator MI,
|
|
|
|
|
ArrayRef<CalleeSavedInfo> CSI,
|
|
|
|
|
const TargetRegisterInfo *TRI) const override {
|
2015-04-22 18:43:53 +02:00
|
|
|
return true;
|
|
|
|
|
}
|
2016-12-16 02:00:40 +01:00
|
|
|
|
2020-02-29 09:50:23 +01:00
|
|
|
bool
|
|
|
|
|
restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator MI,
|
|
|
|
|
MutableArrayRef<CalleeSavedInfo> CSI,
|
|
|
|
|
const TargetRegisterInfo *TRI) const override {
|
2015-04-23 18:05:39 +02:00
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
2017-06-30 23:21:40 +02:00
|
|
|
bool hasReservedCallFrame(const MachineFunction &MF) const override {
|
|
|
|
|
// We always reserve call frame as a part of the initial stack allocation.
|
|
|
|
|
return true;
|
|
|
|
|
}
|
2017-07-27 01:20:35 +02:00
|
|
|
|
2017-06-30 23:21:40 +02:00
|
|
|
bool canSimplifyCallFramePseudos(const MachineFunction &MF) const override {
|
|
|
|
|
// Override this function to avoid calling hasFP before CSI is set
|
|
|
|
|
// (the default implementation calls hasFP).
|
|
|
|
|
return true;
|
|
|
|
|
}
|
2017-07-27 01:20:35 +02:00
|
|
|
|
2016-03-31 20:33:38 +02:00
|
|
|
MachineBasicBlock::iterator
|
|
|
|
|
eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator I) const override;
|
2015-04-22 18:43:53 +02:00
|
|
|
void processFunctionBeforeFrameFinalized(MachineFunction &MF,
|
2016-02-12 19:19:53 +01:00
|
|
|
RegScavenger *RS = nullptr) const override;
|
2015-07-14 19:17:13 +02:00
|
|
|
void determineCalleeSaves(MachineFunction &MF, BitVector &SavedRegs,
|
2016-02-12 19:19:53 +01:00
|
|
|
RegScavenger *RS) const override;
|
2015-04-23 18:05:39 +02:00
|
|
|
|
|
|
|
|
bool targetHandlesStackFrameRounding() const override {
|
|
|
|
|
return true;
|
|
|
|
|
}
|
2016-12-16 02:00:40 +01:00
|
|
|
|
2015-08-15 04:32:35 +02:00
|
|
|
int getFrameIndexReference(const MachineFunction &MF, int FI,
|
2020-04-07 22:33:58 +02:00
|
|
|
Register &FrameReg) const override;
|
2014-04-29 09:58:16 +02:00
|
|
|
bool hasFP(const MachineFunction &MF) const override;
|
2015-04-22 18:43:53 +02:00
|
|
|
|
|
|
|
|
const SpillSlot *getCalleeSavedSpillSlots(unsigned &NumEntries)
|
2016-02-12 19:19:53 +01:00
|
|
|
const override {
|
2015-04-22 18:43:53 +02:00
|
|
|
static const SpillSlot Offsets[] = {
|
|
|
|
|
{ Hexagon::R17, -4 }, { Hexagon::R16, -8 }, { Hexagon::D8, -8 },
|
|
|
|
|
{ Hexagon::R19, -12 }, { Hexagon::R18, -16 }, { Hexagon::D9, -16 },
|
|
|
|
|
{ Hexagon::R21, -20 }, { Hexagon::R20, -24 }, { Hexagon::D10, -24 },
|
|
|
|
|
{ Hexagon::R23, -28 }, { Hexagon::R22, -32 }, { Hexagon::D11, -32 },
|
|
|
|
|
{ Hexagon::R25, -36 }, { Hexagon::R24, -40 }, { Hexagon::D12, -40 },
|
|
|
|
|
{ Hexagon::R27, -44 }, { Hexagon::R26, -48 }, { Hexagon::D13, -48 }
|
|
|
|
|
};
|
|
|
|
|
NumEntries = array_lengthof(Offsets);
|
|
|
|
|
return Offsets;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
bool assignCalleeSavedSpillSlots(MachineFunction &MF,
|
2015-04-23 18:05:39 +02:00
|
|
|
const TargetRegisterInfo *TRI, std::vector<CalleeSavedInfo> &CSI)
|
|
|
|
|
const override;
|
2015-04-22 18:43:53 +02:00
|
|
|
|
|
|
|
|
bool needsAligna(const MachineFunction &MF) const;
|
2015-10-19 20:30:27 +02:00
|
|
|
const MachineInstr *getAlignaInstr(const MachineFunction &MF) const;
|
2015-04-23 18:05:39 +02:00
|
|
|
|
2015-10-19 19:46:01 +02:00
|
|
|
void insertCFIInstructions(MachineFunction &MF) const;
|
|
|
|
|
|
2015-04-23 18:05:39 +02:00
|
|
|
private:
|
2017-07-27 01:20:35 +02:00
|
|
|
using CSIVect = std::vector<CalleeSavedInfo>;
|
2015-04-23 18:05:39 +02:00
|
|
|
|
|
|
|
|
void expandAlloca(MachineInstr *AI, const HexagonInstrInfo &TII,
|
|
|
|
|
unsigned SP, unsigned CF) const;
|
2016-03-24 21:20:07 +01:00
|
|
|
void insertPrologueInBlock(MachineBasicBlock &MBB, bool PrologueStubs) const;
|
2015-04-23 18:05:39 +02:00
|
|
|
void insertEpilogueInBlock(MachineBasicBlock &MBB) const;
|
2017-06-30 23:21:40 +02:00
|
|
|
void insertAllocframe(MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator InsertPt, unsigned NumBytes) const;
|
2015-04-23 18:05:39 +02:00
|
|
|
bool insertCSRSpillsInBlock(MachineBasicBlock &MBB, const CSIVect &CSI,
|
2016-03-24 21:20:07 +01:00
|
|
|
const HexagonRegisterInfo &HRI, bool &PrologueStubs) const;
|
2015-04-23 18:05:39 +02:00
|
|
|
bool insertCSRRestoresInBlock(MachineBasicBlock &MBB, const CSIVect &CSI,
|
|
|
|
|
const HexagonRegisterInfo &HRI) const;
|
2016-07-27 18:26:39 +02:00
|
|
|
void updateEntryPaths(MachineFunction &MF, MachineBasicBlock &SaveB) const;
|
|
|
|
|
bool updateExitPaths(MachineBasicBlock &MBB, MachineBasicBlock &RestoreB,
|
2016-05-26 21:44:28 +02:00
|
|
|
BitVector &DoneT, BitVector &DoneF, BitVector &Path) const;
|
2015-10-19 19:46:01 +02:00
|
|
|
void insertCFIInstructionsAt(MachineBasicBlock &MBB,
|
|
|
|
|
MachineBasicBlock::iterator At) const;
|
2015-04-23 18:05:39 +02:00
|
|
|
|
|
|
|
|
void adjustForCalleeSavedRegsSpillCall(MachineFunction &MF) const;
|
2016-02-12 19:19:53 +01:00
|
|
|
|
|
|
|
|
bool expandCopy(MachineBasicBlock &B, MachineBasicBlock::iterator It,
|
|
|
|
|
MachineRegisterInfo &MRI, const HexagonInstrInfo &HII,
|
|
|
|
|
SmallVectorImpl<unsigned> &NewRegs) const;
|
|
|
|
|
bool expandStoreInt(MachineBasicBlock &B, MachineBasicBlock::iterator It,
|
|
|
|
|
MachineRegisterInfo &MRI, const HexagonInstrInfo &HII,
|
|
|
|
|
SmallVectorImpl<unsigned> &NewRegs) const;
|
|
|
|
|
bool expandLoadInt(MachineBasicBlock &B, MachineBasicBlock::iterator It,
|
|
|
|
|
MachineRegisterInfo &MRI, const HexagonInstrInfo &HII,
|
|
|
|
|
SmallVectorImpl<unsigned> &NewRegs) const;
|
|
|
|
|
bool expandStoreVecPred(MachineBasicBlock &B, MachineBasicBlock::iterator It,
|
|
|
|
|
MachineRegisterInfo &MRI, const HexagonInstrInfo &HII,
|
|
|
|
|
SmallVectorImpl<unsigned> &NewRegs) const;
|
|
|
|
|
bool expandLoadVecPred(MachineBasicBlock &B, MachineBasicBlock::iterator It,
|
|
|
|
|
MachineRegisterInfo &MRI, const HexagonInstrInfo &HII,
|
|
|
|
|
SmallVectorImpl<unsigned> &NewRegs) const;
|
|
|
|
|
bool expandStoreVec2(MachineBasicBlock &B, MachineBasicBlock::iterator It,
|
|
|
|
|
MachineRegisterInfo &MRI, const HexagonInstrInfo &HII,
|
|
|
|
|
SmallVectorImpl<unsigned> &NewRegs) const;
|
|
|
|
|
bool expandLoadVec2(MachineBasicBlock &B, MachineBasicBlock::iterator It,
|
|
|
|
|
MachineRegisterInfo &MRI, const HexagonInstrInfo &HII,
|
|
|
|
|
SmallVectorImpl<unsigned> &NewRegs) const;
|
|
|
|
|
bool expandStoreVec(MachineBasicBlock &B, MachineBasicBlock::iterator It,
|
|
|
|
|
MachineRegisterInfo &MRI, const HexagonInstrInfo &HII,
|
|
|
|
|
SmallVectorImpl<unsigned> &NewRegs) const;
|
|
|
|
|
bool expandLoadVec(MachineBasicBlock &B, MachineBasicBlock::iterator It,
|
|
|
|
|
MachineRegisterInfo &MRI, const HexagonInstrInfo &HII,
|
|
|
|
|
SmallVectorImpl<unsigned> &NewRegs) const;
|
|
|
|
|
bool expandSpillMacros(MachineFunction &MF,
|
|
|
|
|
SmallVectorImpl<unsigned> &NewRegs) const;
|
2015-04-23 18:05:39 +02:00
|
|
|
|
2016-02-12 23:53:35 +01:00
|
|
|
unsigned findPhysReg(MachineFunction &MF, HexagonBlockRanges::IndexRange &FIR,
|
|
|
|
|
HexagonBlockRanges::InstrIndexMap &IndexMap,
|
|
|
|
|
HexagonBlockRanges::RegToRangeMap &DeadMap,
|
|
|
|
|
const TargetRegisterClass *RC) const;
|
|
|
|
|
void optimizeSpillSlots(MachineFunction &MF,
|
|
|
|
|
SmallVectorImpl<unsigned> &VRegs) const;
|
|
|
|
|
|
2015-04-23 18:05:39 +02:00
|
|
|
void findShrunkPrologEpilog(MachineFunction &MF, MachineBasicBlock *&PrologB,
|
|
|
|
|
MachineBasicBlock *&EpilogB) const;
|
|
|
|
|
|
2016-04-25 19:49:44 +02:00
|
|
|
void addCalleeSaveRegistersAsImpOperand(MachineInstr *MI, const CSIVect &CSI,
|
|
|
|
|
bool IsDef, bool IsKill) const;
|
2017-06-30 23:21:40 +02:00
|
|
|
bool shouldInlineCSR(const MachineFunction &MF, const CSIVect &CSI) const;
|
|
|
|
|
bool useSpillFunction(const MachineFunction &MF, const CSIVect &CSI) const;
|
|
|
|
|
bool useRestoreFunction(const MachineFunction &MF, const CSIVect &CSI) const;
|
2016-08-01 19:15:30 +02:00
|
|
|
bool mayOverflowFrameOffset(MachineFunction &MF) const;
|
2011-12-12 22:14:40 +01:00
|
|
|
};
|
|
|
|
|
|
2016-12-16 02:00:40 +01:00
|
|
|
} // end namespace llvm
|
2011-12-12 22:14:40 +01:00
|
|
|
|
2016-12-16 02:00:40 +01:00
|
|
|
#endif // LLVM_LIB_TARGET_HEXAGON_HEXAGONFRAMELOWERING_H
|
