blob: aa732a99469cf3945fa52c0fd47821ea13bd9f30 [file] [log] [blame]
Eugene Zelenko96d933d2017-07-25 23:51:02 +00001//===- AArch64LoadStoreOptimizer.cpp - AArch64 load/store opt. pass -------===//
Tim Northover3b0846e2014-05-24 12:50:23 +00002//
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 contains a pass that performs load / store related peephole
11// optimizations. This pass should be run after register allocation.
12//
13//===----------------------------------------------------------------------===//
14
15#include "AArch64InstrInfo.h"
Eric Christopherd9134482014-08-04 21:25:23 +000016#include "AArch64Subtarget.h"
Tim Northover3b0846e2014-05-24 12:50:23 +000017#include "MCTargetDesc/AArch64AddressingModes.h"
18#include "llvm/ADT/BitVector.h"
Chad Rosierce8e5ab2015-05-21 21:36:46 +000019#include "llvm/ADT/SmallVector.h"
Benjamin Kramer1f8930e2014-07-25 11:42:14 +000020#include "llvm/ADT/Statistic.h"
Eugene Zelenko11f69072017-01-25 00:29:26 +000021#include "llvm/ADT/StringRef.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000022#include "llvm/ADT/iterator_range.h"
Eugene Zelenko96d933d2017-07-25 23:51:02 +000023#include "llvm/Analysis/AliasAnalysis.h"
Tim Northover3b0846e2014-05-24 12:50:23 +000024#include "llvm/CodeGen/MachineBasicBlock.h"
Eugene Zelenko11f69072017-01-25 00:29:26 +000025#include "llvm/CodeGen/MachineFunction.h"
Tim Northover3b0846e2014-05-24 12:50:23 +000026#include "llvm/CodeGen/MachineFunctionPass.h"
27#include "llvm/CodeGen/MachineInstr.h"
28#include "llvm/CodeGen/MachineInstrBuilder.h"
Eugene Zelenko11f69072017-01-25 00:29:26 +000029#include "llvm/CodeGen/MachineOperand.h"
David Blaikieb3bde2e2017-11-17 01:07:10 +000030#include "llvm/CodeGen/TargetRegisterInfo.h"
Eugene Zelenko11f69072017-01-25 00:29:26 +000031#include "llvm/IR/DebugLoc.h"
32#include "llvm/MC/MCRegisterInfo.h"
33#include "llvm/Pass.h"
Tim Northover3b0846e2014-05-24 12:50:23 +000034#include "llvm/Support/CommandLine.h"
35#include "llvm/Support/Debug.h"
36#include "llvm/Support/ErrorHandling.h"
37#include "llvm/Support/raw_ostream.h"
Eugene Zelenko11f69072017-01-25 00:29:26 +000038#include <cassert>
39#include <cstdint>
40#include <iterator>
41#include <limits>
42
Tim Northover3b0846e2014-05-24 12:50:23 +000043using namespace llvm;
44
45#define DEBUG_TYPE "aarch64-ldst-opt"
46
Tim Northover3b0846e2014-05-24 12:50:23 +000047STATISTIC(NumPairCreated, "Number of load/store pair instructions generated");
48STATISTIC(NumPostFolded, "Number of post-index updates folded");
49STATISTIC(NumPreFolded, "Number of pre-index updates folded");
50STATISTIC(NumUnscaledPairCreated,
51 "Number of load/store from unscaled generated");
Jun Bum Lim80ec0d32015-11-20 21:14:07 +000052STATISTIC(NumZeroStoresPromoted, "Number of narrow zero stores promoted");
Jun Bum Lim6755c3b2015-12-22 16:36:16 +000053STATISTIC(NumLoadsFromStoresPromoted, "Number of loads from stores promoted");
Tim Northover3b0846e2014-05-24 12:50:23 +000054
Chad Rosier35706ad2016-02-04 21:26:02 +000055// The LdStLimit limits how far we search for load/store pairs.
56static cl::opt<unsigned> LdStLimit("aarch64-load-store-scan-limit",
Tilmann Scheller5d8d72c2014-06-04 12:40:35 +000057 cl::init(20), cl::Hidden);
Tim Northover3b0846e2014-05-24 12:50:23 +000058
Chad Rosier35706ad2016-02-04 21:26:02 +000059// The UpdateLimit limits how far we search for update instructions when we form
60// pre-/post-index instructions.
61static cl::opt<unsigned> UpdateLimit("aarch64-update-scan-limit", cl::init(100),
62 cl::Hidden);
63
Chad Rosier96530b32015-08-05 13:44:51 +000064#define AARCH64_LOAD_STORE_OPT_NAME "AArch64 load / store optimization pass"
65
Tim Northover3b0846e2014-05-24 12:50:23 +000066namespace {
Chad Rosier96a18a92015-07-21 17:42:04 +000067
Eugene Zelenko96d933d2017-07-25 23:51:02 +000068using LdStPairFlags = struct LdStPairFlags {
Chad Rosier96a18a92015-07-21 17:42:04 +000069 // If a matching instruction is found, MergeForward is set to true if the
70 // merge is to remove the first instruction and replace the second with
71 // a pair-wise insn, and false if the reverse is true.
Eugene Zelenko11f69072017-01-25 00:29:26 +000072 bool MergeForward = false;
Chad Rosier96a18a92015-07-21 17:42:04 +000073
74 // SExtIdx gives the index of the result of the load pair that must be
75 // extended. The value of SExtIdx assumes that the paired load produces the
76 // value in this order: (I, returned iterator), i.e., -1 means no value has
77 // to be extended, 0 means I, and 1 means the returned iterator.
Eugene Zelenko11f69072017-01-25 00:29:26 +000078 int SExtIdx = -1;
Chad Rosier96a18a92015-07-21 17:42:04 +000079
Eugene Zelenko11f69072017-01-25 00:29:26 +000080 LdStPairFlags() = default;
Chad Rosier96a18a92015-07-21 17:42:04 +000081
82 void setMergeForward(bool V = true) { MergeForward = V; }
83 bool getMergeForward() const { return MergeForward; }
84
85 void setSExtIdx(int V) { SExtIdx = V; }
86 int getSExtIdx() const { return SExtIdx; }
Eugene Zelenko96d933d2017-07-25 23:51:02 +000087};
Chad Rosier96a18a92015-07-21 17:42:04 +000088
Tim Northover3b0846e2014-05-24 12:50:23 +000089struct AArch64LoadStoreOpt : public MachineFunctionPass {
90 static char ID;
Eugene Zelenko11f69072017-01-25 00:29:26 +000091
Jun Bum Lim22fe15e2015-11-06 16:27:47 +000092 AArch64LoadStoreOpt() : MachineFunctionPass(ID) {
Chad Rosier96530b32015-08-05 13:44:51 +000093 initializeAArch64LoadStoreOptPass(*PassRegistry::getPassRegistry());
94 }
Tim Northover3b0846e2014-05-24 12:50:23 +000095
Chad Rosiera69dcb62017-03-17 14:19:55 +000096 AliasAnalysis *AA;
Tim Northover3b0846e2014-05-24 12:50:23 +000097 const AArch64InstrInfo *TII;
98 const TargetRegisterInfo *TRI;
Oliver Stannardd414c992015-11-10 11:04:18 +000099 const AArch64Subtarget *Subtarget;
Tim Northover3b0846e2014-05-24 12:50:23 +0000100
Jun Bum Lim47aece12018-04-27 18:44:37 +0000101 // Track which register units have been modified and used.
102 LiveRegUnits ModifiedRegUnits, UsedRegUnits;
Chad Rosierbba881e2016-02-02 15:02:30 +0000103
Eugene Zelenko96d933d2017-07-25 23:51:02 +0000104 void getAnalysisUsage(AnalysisUsage &AU) const override {
Chad Rosiera69dcb62017-03-17 14:19:55 +0000105 AU.addRequired<AAResultsWrapperPass>();
106 MachineFunctionPass::getAnalysisUsage(AU);
107 }
108
Tim Northover3b0846e2014-05-24 12:50:23 +0000109 // Scan the instructions looking for a load/store that can be combined
110 // with the current instruction into a load/store pair.
111 // Return the matching instruction if one is found, else MBB->end().
Tim Northover3b0846e2014-05-24 12:50:23 +0000112 MachineBasicBlock::iterator findMatchingInsn(MachineBasicBlock::iterator I,
Chad Rosier96a18a92015-07-21 17:42:04 +0000113 LdStPairFlags &Flags,
Jun Bum Limcf974432016-03-31 14:47:24 +0000114 unsigned Limit,
115 bool FindNarrowMerge);
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000116
117 // Scan the instructions looking for a store that writes to the address from
118 // which the current load instruction reads. Return true if one is found.
119 bool findMatchingStore(MachineBasicBlock::iterator I, unsigned Limit,
120 MachineBasicBlock::iterator &StoreI);
121
Chad Rosierd6daac42016-11-07 15:27:22 +0000122 // Merge the two instructions indicated into a wider narrow store instruction.
Chad Rosierb5933d72016-02-09 19:02:12 +0000123 MachineBasicBlock::iterator
Chad Rosierd6daac42016-11-07 15:27:22 +0000124 mergeNarrowZeroStores(MachineBasicBlock::iterator I,
125 MachineBasicBlock::iterator MergeMI,
126 const LdStPairFlags &Flags);
Chad Rosierb5933d72016-02-09 19:02:12 +0000127
Tim Northover3b0846e2014-05-24 12:50:23 +0000128 // Merge the two instructions indicated into a single pair-wise instruction.
Tim Northover3b0846e2014-05-24 12:50:23 +0000129 MachineBasicBlock::iterator
130 mergePairedInsns(MachineBasicBlock::iterator I,
Chad Rosier96a18a92015-07-21 17:42:04 +0000131 MachineBasicBlock::iterator Paired,
Chad Rosierfe5399f2015-07-21 17:47:56 +0000132 const LdStPairFlags &Flags);
Tim Northover3b0846e2014-05-24 12:50:23 +0000133
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000134 // Promote the load that reads directly from the address stored to.
135 MachineBasicBlock::iterator
136 promoteLoadFromStore(MachineBasicBlock::iterator LoadI,
137 MachineBasicBlock::iterator StoreI);
138
Tim Northover3b0846e2014-05-24 12:50:23 +0000139 // Scan the instruction list to find a base register update that can
140 // be combined with the current instruction (a load or store) using
141 // pre or post indexed addressing with writeback. Scan forwards.
142 MachineBasicBlock::iterator
Chad Rosier234bf6f2016-01-18 21:56:40 +0000143 findMatchingUpdateInsnForward(MachineBasicBlock::iterator I,
Chad Rosier35706ad2016-02-04 21:26:02 +0000144 int UnscaledOffset, unsigned Limit);
Tim Northover3b0846e2014-05-24 12:50:23 +0000145
146 // Scan the instruction list to find a base register update that can
147 // be combined with the current instruction (a load or store) using
148 // pre or post indexed addressing with writeback. Scan backwards.
149 MachineBasicBlock::iterator
Chad Rosier35706ad2016-02-04 21:26:02 +0000150 findMatchingUpdateInsnBackward(MachineBasicBlock::iterator I, unsigned Limit);
Tim Northover3b0846e2014-05-24 12:50:23 +0000151
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000152 // Find an instruction that updates the base register of the ld/st
153 // instruction.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000154 bool isMatchingUpdateInsn(MachineInstr &MemMI, MachineInstr &MI,
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000155 unsigned BaseReg, int Offset);
156
Chad Rosier2dfd3542015-09-23 13:51:44 +0000157 // Merge a pre- or post-index base register update into a ld/st instruction.
Tim Northover3b0846e2014-05-24 12:50:23 +0000158 MachineBasicBlock::iterator
Chad Rosier2dfd3542015-09-23 13:51:44 +0000159 mergeUpdateInsn(MachineBasicBlock::iterator I,
160 MachineBasicBlock::iterator Update, bool IsPreIdx);
Tim Northover3b0846e2014-05-24 12:50:23 +0000161
Chad Rosierd6daac42016-11-07 15:27:22 +0000162 // Find and merge zero store instructions.
163 bool tryToMergeZeroStInst(MachineBasicBlock::iterator &MBBI);
Jun Bum Limc9879ec2015-10-27 19:16:03 +0000164
Chad Rosier24c46ad2016-02-09 18:10:20 +0000165 // Find and pair ldr/str instructions.
166 bool tryToPairLdStInst(MachineBasicBlock::iterator &MBBI);
167
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000168 // Find and promote load instructions which read directly from store.
169 bool tryToPromoteLoadFromStore(MachineBasicBlock::iterator &MBBI);
170
Evandro Menezes5ba804b2017-11-15 21:06:22 +0000171 // Find and merge a base register updates before or after a ld/st instruction.
172 bool tryToMergeLdStUpdate(MachineBasicBlock::iterator &MBBI);
173
Chad Rosierd6daac42016-11-07 15:27:22 +0000174 bool optimizeBlock(MachineBasicBlock &MBB, bool EnableNarrowZeroStOpt);
Tim Northover3b0846e2014-05-24 12:50:23 +0000175
176 bool runOnMachineFunction(MachineFunction &Fn) override;
177
Derek Schuff1dbf7a52016-04-04 17:09:25 +0000178 MachineFunctionProperties getRequiredProperties() const override {
179 return MachineFunctionProperties().set(
Matthias Braun1eb47362016-08-25 01:27:13 +0000180 MachineFunctionProperties::Property::NoVRegs);
Derek Schuff1dbf7a52016-04-04 17:09:25 +0000181 }
182
Mehdi Amini117296c2016-10-01 02:56:57 +0000183 StringRef getPassName() const override { return AARCH64_LOAD_STORE_OPT_NAME; }
Tim Northover3b0846e2014-05-24 12:50:23 +0000184};
Eugene Zelenko11f69072017-01-25 00:29:26 +0000185
Tim Northover3b0846e2014-05-24 12:50:23 +0000186char AArch64LoadStoreOpt::ID = 0;
Eugene Zelenko11f69072017-01-25 00:29:26 +0000187
188} // end anonymous namespace
Tim Northover3b0846e2014-05-24 12:50:23 +0000189
Chad Rosier96530b32015-08-05 13:44:51 +0000190INITIALIZE_PASS(AArch64LoadStoreOpt, "aarch64-ldst-opt",
191 AARCH64_LOAD_STORE_OPT_NAME, false, false)
192
Jun Bum Lim80ec0d32015-11-20 21:14:07 +0000193static bool isNarrowStore(unsigned Opc) {
194 switch (Opc) {
195 default:
196 return false;
197 case AArch64::STRBBui:
198 case AArch64::STURBBi:
199 case AArch64::STRHHui:
200 case AArch64::STURHHi:
201 return true;
202 }
203}
204
Chad Rosier32d4d372015-09-29 16:07:32 +0000205// Scaling factor for unscaled load or store.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000206static int getMemScale(MachineInstr &MI) {
207 switch (MI.getOpcode()) {
Tim Northover3b0846e2014-05-24 12:50:23 +0000208 default:
Chad Rosierdabe2532015-09-29 18:26:15 +0000209 llvm_unreachable("Opcode has unknown scale!");
210 case AArch64::LDRBBui:
Jun Bum Lim4c35cca2015-11-19 17:21:41 +0000211 case AArch64::LDURBBi:
212 case AArch64::LDRSBWui:
213 case AArch64::LDURSBWi:
Chad Rosierdabe2532015-09-29 18:26:15 +0000214 case AArch64::STRBBui:
Jun Bum Lim80ec0d32015-11-20 21:14:07 +0000215 case AArch64::STURBBi:
Chad Rosierdabe2532015-09-29 18:26:15 +0000216 return 1;
217 case AArch64::LDRHHui:
Jun Bum Limc9879ec2015-10-27 19:16:03 +0000218 case AArch64::LDURHHi:
Jun Bum Lim4c35cca2015-11-19 17:21:41 +0000219 case AArch64::LDRSHWui:
220 case AArch64::LDURSHWi:
Chad Rosierdabe2532015-09-29 18:26:15 +0000221 case AArch64::STRHHui:
Jun Bum Lim80ec0d32015-11-20 21:14:07 +0000222 case AArch64::STURHHi:
Chad Rosierdabe2532015-09-29 18:26:15 +0000223 return 2;
Chad Rosiera4d32172015-09-29 14:57:10 +0000224 case AArch64::LDRSui:
225 case AArch64::LDURSi:
226 case AArch64::LDRSWui:
227 case AArch64::LDURSWi:
228 case AArch64::LDRWui:
229 case AArch64::LDURWi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000230 case AArch64::STRSui:
231 case AArch64::STURSi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000232 case AArch64::STRWui:
233 case AArch64::STURWi:
Chad Rosier32d4d372015-09-29 16:07:32 +0000234 case AArch64::LDPSi:
Chad Rosier43150122015-09-29 20:39:55 +0000235 case AArch64::LDPSWi:
Chad Rosier32d4d372015-09-29 16:07:32 +0000236 case AArch64::LDPWi:
237 case AArch64::STPSi:
238 case AArch64::STPWi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000239 return 4;
Chad Rosiera4d32172015-09-29 14:57:10 +0000240 case AArch64::LDRDui:
241 case AArch64::LDURDi:
242 case AArch64::LDRXui:
243 case AArch64::LDURXi:
244 case AArch64::STRDui:
245 case AArch64::STURDi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000246 case AArch64::STRXui:
247 case AArch64::STURXi:
Chad Rosier32d4d372015-09-29 16:07:32 +0000248 case AArch64::LDPDi:
249 case AArch64::LDPXi:
250 case AArch64::STPDi:
251 case AArch64::STPXi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000252 return 8;
Tim Northover3b0846e2014-05-24 12:50:23 +0000253 case AArch64::LDRQui:
254 case AArch64::LDURQi:
Chad Rosiera4d32172015-09-29 14:57:10 +0000255 case AArch64::STRQui:
256 case AArch64::STURQi:
Chad Rosier32d4d372015-09-29 16:07:32 +0000257 case AArch64::LDPQi:
258 case AArch64::STPQi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000259 return 16;
Tim Northover3b0846e2014-05-24 12:50:23 +0000260 }
261}
262
Quentin Colombet66b61632015-03-06 22:42:10 +0000263static unsigned getMatchingNonSExtOpcode(unsigned Opc,
264 bool *IsValidLdStrOpc = nullptr) {
265 if (IsValidLdStrOpc)
266 *IsValidLdStrOpc = true;
267 switch (Opc) {
268 default:
269 if (IsValidLdStrOpc)
270 *IsValidLdStrOpc = false;
Eugene Zelenko11f69072017-01-25 00:29:26 +0000271 return std::numeric_limits<unsigned>::max();
Quentin Colombet66b61632015-03-06 22:42:10 +0000272 case AArch64::STRDui:
273 case AArch64::STURDi:
274 case AArch64::STRQui:
275 case AArch64::STURQi:
Jun Bum Lim80ec0d32015-11-20 21:14:07 +0000276 case AArch64::STRBBui:
277 case AArch64::STURBBi:
278 case AArch64::STRHHui:
279 case AArch64::STURHHi:
Quentin Colombet66b61632015-03-06 22:42:10 +0000280 case AArch64::STRWui:
281 case AArch64::STURWi:
282 case AArch64::STRXui:
283 case AArch64::STURXi:
284 case AArch64::LDRDui:
285 case AArch64::LDURDi:
286 case AArch64::LDRQui:
287 case AArch64::LDURQi:
288 case AArch64::LDRWui:
289 case AArch64::LDURWi:
290 case AArch64::LDRXui:
291 case AArch64::LDURXi:
292 case AArch64::STRSui:
293 case AArch64::STURSi:
294 case AArch64::LDRSui:
295 case AArch64::LDURSi:
296 return Opc;
297 case AArch64::LDRSWui:
298 return AArch64::LDRWui;
299 case AArch64::LDURSWi:
300 return AArch64::LDURWi;
301 }
302}
303
Jun Bum Lim1de2d442016-02-05 20:02:03 +0000304static unsigned getMatchingWideOpcode(unsigned Opc) {
305 switch (Opc) {
306 default:
307 llvm_unreachable("Opcode has no wide equivalent!");
308 case AArch64::STRBBui:
309 return AArch64::STRHHui;
310 case AArch64::STRHHui:
311 return AArch64::STRWui;
312 case AArch64::STURBBi:
313 return AArch64::STURHHi;
314 case AArch64::STURHHi:
315 return AArch64::STURWi;
Jun Bum Lim397eb7b2016-02-12 15:25:39 +0000316 case AArch64::STURWi:
317 return AArch64::STURXi;
318 case AArch64::STRWui:
319 return AArch64::STRXui;
Jun Bum Lim1de2d442016-02-05 20:02:03 +0000320 }
321}
322
Tim Northover3b0846e2014-05-24 12:50:23 +0000323static unsigned getMatchingPairOpcode(unsigned Opc) {
324 switch (Opc) {
325 default:
326 llvm_unreachable("Opcode has no pairwise equivalent!");
327 case AArch64::STRSui:
328 case AArch64::STURSi:
329 return AArch64::STPSi;
330 case AArch64::STRDui:
331 case AArch64::STURDi:
332 return AArch64::STPDi;
333 case AArch64::STRQui:
334 case AArch64::STURQi:
335 return AArch64::STPQi;
336 case AArch64::STRWui:
337 case AArch64::STURWi:
338 return AArch64::STPWi;
339 case AArch64::STRXui:
340 case AArch64::STURXi:
341 return AArch64::STPXi;
342 case AArch64::LDRSui:
343 case AArch64::LDURSi:
344 return AArch64::LDPSi;
345 case AArch64::LDRDui:
346 case AArch64::LDURDi:
347 return AArch64::LDPDi;
348 case AArch64::LDRQui:
349 case AArch64::LDURQi:
350 return AArch64::LDPQi;
351 case AArch64::LDRWui:
352 case AArch64::LDURWi:
353 return AArch64::LDPWi;
354 case AArch64::LDRXui:
355 case AArch64::LDURXi:
356 return AArch64::LDPXi;
Quentin Colombet29f55332015-01-24 01:25:54 +0000357 case AArch64::LDRSWui:
358 case AArch64::LDURSWi:
359 return AArch64::LDPSWi;
Tim Northover3b0846e2014-05-24 12:50:23 +0000360 }
361}
362
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000363static unsigned isMatchingStore(MachineInstr &LoadInst,
364 MachineInstr &StoreInst) {
365 unsigned LdOpc = LoadInst.getOpcode();
366 unsigned StOpc = StoreInst.getOpcode();
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000367 switch (LdOpc) {
368 default:
369 llvm_unreachable("Unsupported load instruction!");
370 case AArch64::LDRBBui:
371 return StOpc == AArch64::STRBBui || StOpc == AArch64::STRHHui ||
372 StOpc == AArch64::STRWui || StOpc == AArch64::STRXui;
373 case AArch64::LDURBBi:
374 return StOpc == AArch64::STURBBi || StOpc == AArch64::STURHHi ||
375 StOpc == AArch64::STURWi || StOpc == AArch64::STURXi;
376 case AArch64::LDRHHui:
377 return StOpc == AArch64::STRHHui || StOpc == AArch64::STRWui ||
378 StOpc == AArch64::STRXui;
379 case AArch64::LDURHHi:
380 return StOpc == AArch64::STURHHi || StOpc == AArch64::STURWi ||
381 StOpc == AArch64::STURXi;
382 case AArch64::LDRWui:
383 return StOpc == AArch64::STRWui || StOpc == AArch64::STRXui;
384 case AArch64::LDURWi:
385 return StOpc == AArch64::STURWi || StOpc == AArch64::STURXi;
386 case AArch64::LDRXui:
387 return StOpc == AArch64::STRXui;
388 case AArch64::LDURXi:
389 return StOpc == AArch64::STURXi;
390 }
391}
392
Tim Northover3b0846e2014-05-24 12:50:23 +0000393static unsigned getPreIndexedOpcode(unsigned Opc) {
Chad Rosier14fc82a2017-08-04 16:44:06 +0000394 // FIXME: We don't currently support creating pre-indexed loads/stores when
395 // the load or store is the unscaled version. If we decide to perform such an
396 // optimization in the future the cases for the unscaled loads/stores will
397 // need to be added here.
Tim Northover3b0846e2014-05-24 12:50:23 +0000398 switch (Opc) {
399 default:
400 llvm_unreachable("Opcode has no pre-indexed equivalent!");
Tilmann Scheller5d8d72c2014-06-04 12:40:35 +0000401 case AArch64::STRSui:
402 return AArch64::STRSpre;
403 case AArch64::STRDui:
404 return AArch64::STRDpre;
405 case AArch64::STRQui:
406 return AArch64::STRQpre;
Chad Rosierdabe2532015-09-29 18:26:15 +0000407 case AArch64::STRBBui:
408 return AArch64::STRBBpre;
409 case AArch64::STRHHui:
410 return AArch64::STRHHpre;
Tilmann Scheller5d8d72c2014-06-04 12:40:35 +0000411 case AArch64::STRWui:
412 return AArch64::STRWpre;
413 case AArch64::STRXui:
414 return AArch64::STRXpre;
415 case AArch64::LDRSui:
416 return AArch64::LDRSpre;
417 case AArch64::LDRDui:
418 return AArch64::LDRDpre;
419 case AArch64::LDRQui:
420 return AArch64::LDRQpre;
Chad Rosierdabe2532015-09-29 18:26:15 +0000421 case AArch64::LDRBBui:
422 return AArch64::LDRBBpre;
423 case AArch64::LDRHHui:
424 return AArch64::LDRHHpre;
Tilmann Scheller5d8d72c2014-06-04 12:40:35 +0000425 case AArch64::LDRWui:
426 return AArch64::LDRWpre;
427 case AArch64::LDRXui:
428 return AArch64::LDRXpre;
Quentin Colombet29f55332015-01-24 01:25:54 +0000429 case AArch64::LDRSWui:
430 return AArch64::LDRSWpre;
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000431 case AArch64::LDPSi:
432 return AArch64::LDPSpre;
Chad Rosier43150122015-09-29 20:39:55 +0000433 case AArch64::LDPSWi:
434 return AArch64::LDPSWpre;
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000435 case AArch64::LDPDi:
436 return AArch64::LDPDpre;
437 case AArch64::LDPQi:
438 return AArch64::LDPQpre;
439 case AArch64::LDPWi:
440 return AArch64::LDPWpre;
441 case AArch64::LDPXi:
442 return AArch64::LDPXpre;
443 case AArch64::STPSi:
444 return AArch64::STPSpre;
445 case AArch64::STPDi:
446 return AArch64::STPDpre;
447 case AArch64::STPQi:
448 return AArch64::STPQpre;
449 case AArch64::STPWi:
450 return AArch64::STPWpre;
451 case AArch64::STPXi:
452 return AArch64::STPXpre;
Tim Northover3b0846e2014-05-24 12:50:23 +0000453 }
454}
455
456static unsigned getPostIndexedOpcode(unsigned Opc) {
457 switch (Opc) {
458 default:
459 llvm_unreachable("Opcode has no post-indexed wise equivalent!");
460 case AArch64::STRSui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000461 case AArch64::STURSi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000462 return AArch64::STRSpost;
463 case AArch64::STRDui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000464 case AArch64::STURDi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000465 return AArch64::STRDpost;
466 case AArch64::STRQui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000467 case AArch64::STURQi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000468 return AArch64::STRQpost;
Chad Rosierdabe2532015-09-29 18:26:15 +0000469 case AArch64::STRBBui:
470 return AArch64::STRBBpost;
471 case AArch64::STRHHui:
472 return AArch64::STRHHpost;
Tim Northover3b0846e2014-05-24 12:50:23 +0000473 case AArch64::STRWui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000474 case AArch64::STURWi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000475 return AArch64::STRWpost;
476 case AArch64::STRXui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000477 case AArch64::STURXi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000478 return AArch64::STRXpost;
479 case AArch64::LDRSui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000480 case AArch64::LDURSi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000481 return AArch64::LDRSpost;
482 case AArch64::LDRDui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000483 case AArch64::LDURDi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000484 return AArch64::LDRDpost;
485 case AArch64::LDRQui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000486 case AArch64::LDURQi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000487 return AArch64::LDRQpost;
Chad Rosierdabe2532015-09-29 18:26:15 +0000488 case AArch64::LDRBBui:
489 return AArch64::LDRBBpost;
490 case AArch64::LDRHHui:
491 return AArch64::LDRHHpost;
Tim Northover3b0846e2014-05-24 12:50:23 +0000492 case AArch64::LDRWui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000493 case AArch64::LDURWi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000494 return AArch64::LDRWpost;
495 case AArch64::LDRXui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000496 case AArch64::LDURXi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000497 return AArch64::LDRXpost;
Quentin Colombet29f55332015-01-24 01:25:54 +0000498 case AArch64::LDRSWui:
499 return AArch64::LDRSWpost;
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000500 case AArch64::LDPSi:
501 return AArch64::LDPSpost;
Chad Rosier43150122015-09-29 20:39:55 +0000502 case AArch64::LDPSWi:
503 return AArch64::LDPSWpost;
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000504 case AArch64::LDPDi:
505 return AArch64::LDPDpost;
506 case AArch64::LDPQi:
507 return AArch64::LDPQpost;
508 case AArch64::LDPWi:
509 return AArch64::LDPWpost;
510 case AArch64::LDPXi:
511 return AArch64::LDPXpost;
512 case AArch64::STPSi:
513 return AArch64::STPSpost;
514 case AArch64::STPDi:
515 return AArch64::STPDpost;
516 case AArch64::STPQi:
517 return AArch64::STPQpost;
518 case AArch64::STPWi:
519 return AArch64::STPWpost;
520 case AArch64::STPXi:
521 return AArch64::STPXpost;
Tim Northover3b0846e2014-05-24 12:50:23 +0000522 }
523}
524
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000525static bool isPairedLdSt(const MachineInstr &MI) {
526 switch (MI.getOpcode()) {
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000527 default:
528 return false;
529 case AArch64::LDPSi:
Chad Rosier43150122015-09-29 20:39:55 +0000530 case AArch64::LDPSWi:
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000531 case AArch64::LDPDi:
532 case AArch64::LDPQi:
533 case AArch64::LDPWi:
534 case AArch64::LDPXi:
535 case AArch64::STPSi:
536 case AArch64::STPDi:
537 case AArch64::STPQi:
538 case AArch64::STPWi:
539 case AArch64::STPXi:
540 return true;
541 }
542}
543
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000544static const MachineOperand &getLdStRegOp(const MachineInstr &MI,
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000545 unsigned PairedRegOp = 0) {
546 assert(PairedRegOp < 2 && "Unexpected register operand idx.");
547 unsigned Idx = isPairedLdSt(MI) ? PairedRegOp : 0;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000548 return MI.getOperand(Idx);
Chad Rosierf77e9092015-08-06 15:50:12 +0000549}
550
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000551static const MachineOperand &getLdStBaseOp(const MachineInstr &MI) {
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000552 unsigned Idx = isPairedLdSt(MI) ? 2 : 1;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000553 return MI.getOperand(Idx);
Chad Rosierf77e9092015-08-06 15:50:12 +0000554}
555
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000556static const MachineOperand &getLdStOffsetOp(const MachineInstr &MI) {
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000557 unsigned Idx = isPairedLdSt(MI) ? 3 : 2;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000558 return MI.getOperand(Idx);
Chad Rosierf77e9092015-08-06 15:50:12 +0000559}
560
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000561static bool isLdOffsetInRangeOfSt(MachineInstr &LoadInst,
562 MachineInstr &StoreInst,
Chad Rosiere4e15ba2016-03-09 17:29:48 +0000563 const AArch64InstrInfo *TII) {
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000564 assert(isMatchingStore(LoadInst, StoreInst) && "Expect only matched ld/st.");
565 int LoadSize = getMemScale(LoadInst);
566 int StoreSize = getMemScale(StoreInst);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000567 int UnscaledStOffset = TII->isUnscaledLdSt(StoreInst)
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000568 ? getLdStOffsetOp(StoreInst).getImm()
569 : getLdStOffsetOp(StoreInst).getImm() * StoreSize;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000570 int UnscaledLdOffset = TII->isUnscaledLdSt(LoadInst)
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000571 ? getLdStOffsetOp(LoadInst).getImm()
572 : getLdStOffsetOp(LoadInst).getImm() * LoadSize;
573 return (UnscaledStOffset <= UnscaledLdOffset) &&
574 (UnscaledLdOffset + LoadSize <= (UnscaledStOffset + StoreSize));
575}
576
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000577static bool isPromotableZeroStoreInst(MachineInstr &MI) {
Chad Rosierd6daac42016-11-07 15:27:22 +0000578 unsigned Opc = MI.getOpcode();
579 return (Opc == AArch64::STRWui || Opc == AArch64::STURWi ||
580 isNarrowStore(Opc)) &&
Jun Bum Lim397eb7b2016-02-12 15:25:39 +0000581 getLdStRegOp(MI).getReg() == AArch64::WZR;
582}
583
Evandro Menezes5ba804b2017-11-15 21:06:22 +0000584static bool isPromotableLoadFromStore(MachineInstr &MI) {
585 switch (MI.getOpcode()) {
586 default:
587 return false;
588 // Scaled instructions.
589 case AArch64::LDRBBui:
590 case AArch64::LDRHHui:
591 case AArch64::LDRWui:
592 case AArch64::LDRXui:
593 // Unscaled instructions.
594 case AArch64::LDURBBi:
595 case AArch64::LDURHHi:
596 case AArch64::LDURWi:
597 case AArch64::LDURXi:
598 return true;
599 }
600}
601
602static bool isMergeableLdStUpdate(MachineInstr &MI) {
603 unsigned Opc = MI.getOpcode();
604 switch (Opc) {
605 default:
606 return false;
607 // Scaled instructions.
608 case AArch64::STRSui:
609 case AArch64::STRDui:
610 case AArch64::STRQui:
611 case AArch64::STRXui:
612 case AArch64::STRWui:
613 case AArch64::STRHHui:
614 case AArch64::STRBBui:
615 case AArch64::LDRSui:
616 case AArch64::LDRDui:
617 case AArch64::LDRQui:
618 case AArch64::LDRXui:
619 case AArch64::LDRWui:
620 case AArch64::LDRHHui:
621 case AArch64::LDRBBui:
622 // Unscaled instructions.
623 case AArch64::STURSi:
624 case AArch64::STURDi:
625 case AArch64::STURQi:
626 case AArch64::STURWi:
627 case AArch64::STURXi:
628 case AArch64::LDURSi:
629 case AArch64::LDURDi:
630 case AArch64::LDURQi:
631 case AArch64::LDURWi:
632 case AArch64::LDURXi:
633 // Paired instructions.
634 case AArch64::LDPSi:
635 case AArch64::LDPSWi:
636 case AArch64::LDPDi:
637 case AArch64::LDPQi:
638 case AArch64::LDPWi:
639 case AArch64::LDPXi:
640 case AArch64::STPSi:
641 case AArch64::STPDi:
642 case AArch64::STPQi:
643 case AArch64::STPWi:
644 case AArch64::STPXi:
645 // Make sure this is a reg+imm (as opposed to an address reloc).
646 if (!getLdStOffsetOp(MI).isImm())
647 return false;
648
649 return true;
650 }
651}
652
Tim Northover3b0846e2014-05-24 12:50:23 +0000653MachineBasicBlock::iterator
Chad Rosierd6daac42016-11-07 15:27:22 +0000654AArch64LoadStoreOpt::mergeNarrowZeroStores(MachineBasicBlock::iterator I,
655 MachineBasicBlock::iterator MergeMI,
656 const LdStPairFlags &Flags) {
657 assert(isPromotableZeroStoreInst(*I) && isPromotableZeroStoreInst(*MergeMI) &&
658 "Expected promotable zero stores.");
659
Tim Northover3b0846e2014-05-24 12:50:23 +0000660 MachineBasicBlock::iterator NextI = I;
661 ++NextI;
662 // If NextI is the second of the two instructions to be merged, we need
663 // to skip one further. Either way we merge will invalidate the iterator,
664 // and we don't need to scan the new instruction, as it's a pairwise
665 // instruction, which we're not considering for further action anyway.
Chad Rosierd7363db2016-02-09 19:09:22 +0000666 if (NextI == MergeMI)
Tim Northover3b0846e2014-05-24 12:50:23 +0000667 ++NextI;
668
Chad Rosierb5933d72016-02-09 19:02:12 +0000669 unsigned Opc = I->getOpcode();
Chad Rosiere4e15ba2016-03-09 17:29:48 +0000670 bool IsScaled = !TII->isUnscaledLdSt(Opc);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000671 int OffsetStride = IsScaled ? 1 : getMemScale(*I);
Tim Northover3b0846e2014-05-24 12:50:23 +0000672
Chad Rosier96a18a92015-07-21 17:42:04 +0000673 bool MergeForward = Flags.getMergeForward();
Tim Northover3b0846e2014-05-24 12:50:23 +0000674 // Insert our new paired instruction after whichever of the paired
Tilmann Scheller4aad3bd2014-06-04 12:36:28 +0000675 // instructions MergeForward indicates.
Chad Rosierd7363db2016-02-09 19:09:22 +0000676 MachineBasicBlock::iterator InsertionPoint = MergeForward ? MergeMI : I;
Tilmann Scheller4aad3bd2014-06-04 12:36:28 +0000677 // Also based on MergeForward is from where we copy the base register operand
Tim Northover3b0846e2014-05-24 12:50:23 +0000678 // so we get the flags compatible with the input code.
Chad Rosierf77e9092015-08-06 15:50:12 +0000679 const MachineOperand &BaseRegOp =
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000680 MergeForward ? getLdStBaseOp(*MergeMI) : getLdStBaseOp(*I);
Tim Northover3b0846e2014-05-24 12:50:23 +0000681
682 // Which register is Rt and which is Rt2 depends on the offset order.
Davide Italiano5df60662016-11-07 19:11:25 +0000683 MachineInstr *RtMI;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000684 if (getLdStOffsetOp(*I).getImm() ==
Davide Italiano5df60662016-11-07 19:11:25 +0000685 getLdStOffsetOp(*MergeMI).getImm() + OffsetStride)
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000686 RtMI = &*MergeMI;
Davide Italiano5df60662016-11-07 19:11:25 +0000687 else
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000688 RtMI = &*I;
Jun Bum Limc9879ec2015-10-27 19:16:03 +0000689
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000690 int OffsetImm = getLdStOffsetOp(*RtMI).getImm();
Chad Rosier11eedc92016-02-09 19:17:18 +0000691 // Change the scaled offset from small to large type.
692 if (IsScaled) {
693 assert(((OffsetImm & 1) == 0) && "Unexpected offset to merge");
694 OffsetImm /= 2;
695 }
696
Chad Rosierd6daac42016-11-07 15:27:22 +0000697 // Construct the new instruction.
Chad Rosierc46ef882016-02-09 19:33:42 +0000698 DebugLoc DL = I->getDebugLoc();
699 MachineBasicBlock *MBB = I->getParent();
Jun Bum Lim80ec0d32015-11-20 21:14:07 +0000700 MachineInstrBuilder MIB;
Chad Rosierc46ef882016-02-09 19:33:42 +0000701 MIB = BuildMI(*MBB, InsertionPoint, DL, TII->get(getMatchingWideOpcode(Opc)))
Jun Bum Lim397eb7b2016-02-12 15:25:39 +0000702 .addReg(isNarrowStore(Opc) ? AArch64::WZR : AArch64::XZR)
Diana Picus116bbab2017-01-13 09:58:52 +0000703 .add(BaseRegOp)
Chad Rosierb5933d72016-02-09 19:02:12 +0000704 .addImm(OffsetImm)
Chandler Carruthc73c0302018-08-16 21:30:05 +0000705 .cloneMergedMemRefs({&*I, &*MergeMI})
Francis Visoiu Mistrih084e7d82018-03-14 17:10:58 +0000706 .setMIFlags(I->mergeFlagsWith(*MergeMI));
Tim Northover3b0846e2014-05-24 12:50:23 +0000707 (void)MIB;
708
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000709 LLVM_DEBUG(dbgs() << "Creating wider store. Replacing instructions:\n ");
710 LLVM_DEBUG(I->print(dbgs()));
711 LLVM_DEBUG(dbgs() << " ");
712 LLVM_DEBUG(MergeMI->print(dbgs()));
713 LLVM_DEBUG(dbgs() << " with instruction:\n ");
714 LLVM_DEBUG(((MachineInstr *)MIB)->print(dbgs()));
715 LLVM_DEBUG(dbgs() << "\n");
Chad Rosierb5933d72016-02-09 19:02:12 +0000716
717 // Erase the old instructions.
718 I->eraseFromParent();
Chad Rosierd7363db2016-02-09 19:09:22 +0000719 MergeMI->eraseFromParent();
Chad Rosierb5933d72016-02-09 19:02:12 +0000720 return NextI;
721}
722
723MachineBasicBlock::iterator
724AArch64LoadStoreOpt::mergePairedInsns(MachineBasicBlock::iterator I,
725 MachineBasicBlock::iterator Paired,
726 const LdStPairFlags &Flags) {
727 MachineBasicBlock::iterator NextI = I;
728 ++NextI;
729 // If NextI is the second of the two instructions to be merged, we need
730 // to skip one further. Either way we merge will invalidate the iterator,
731 // and we don't need to scan the new instruction, as it's a pairwise
732 // instruction, which we're not considering for further action anyway.
733 if (NextI == Paired)
734 ++NextI;
735
736 int SExtIdx = Flags.getSExtIdx();
737 unsigned Opc =
738 SExtIdx == -1 ? I->getOpcode() : getMatchingNonSExtOpcode(I->getOpcode());
Chad Rosiere4e15ba2016-03-09 17:29:48 +0000739 bool IsUnscaled = TII->isUnscaledLdSt(Opc);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000740 int OffsetStride = IsUnscaled ? getMemScale(*I) : 1;
Chad Rosierb5933d72016-02-09 19:02:12 +0000741
742 bool MergeForward = Flags.getMergeForward();
743 // Insert our new paired instruction after whichever of the paired
744 // instructions MergeForward indicates.
745 MachineBasicBlock::iterator InsertionPoint = MergeForward ? Paired : I;
746 // Also based on MergeForward is from where we copy the base register operand
747 // so we get the flags compatible with the input code.
748 const MachineOperand &BaseRegOp =
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000749 MergeForward ? getLdStBaseOp(*Paired) : getLdStBaseOp(*I);
Chad Rosierb5933d72016-02-09 19:02:12 +0000750
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000751 int Offset = getLdStOffsetOp(*I).getImm();
752 int PairedOffset = getLdStOffsetOp(*Paired).getImm();
Chad Rosiere4e15ba2016-03-09 17:29:48 +0000753 bool PairedIsUnscaled = TII->isUnscaledLdSt(Paired->getOpcode());
Chad Rosier00f9d232016-02-11 14:25:08 +0000754 if (IsUnscaled != PairedIsUnscaled) {
755 // We're trying to pair instructions that differ in how they are scaled. If
756 // I is scaled then scale the offset of Paired accordingly. Otherwise, do
757 // the opposite (i.e., make Paired's offset unscaled).
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000758 int MemSize = getMemScale(*Paired);
Chad Rosier00f9d232016-02-11 14:25:08 +0000759 if (PairedIsUnscaled) {
760 // If the unscaled offset isn't a multiple of the MemSize, we can't
761 // pair the operations together.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000762 assert(!(PairedOffset % getMemScale(*Paired)) &&
Chad Rosier00f9d232016-02-11 14:25:08 +0000763 "Offset should be a multiple of the stride!");
764 PairedOffset /= MemSize;
765 } else {
766 PairedOffset *= MemSize;
767 }
768 }
769
Chad Rosierb5933d72016-02-09 19:02:12 +0000770 // Which register is Rt and which is Rt2 depends on the offset order.
771 MachineInstr *RtMI, *Rt2MI;
Chad Rosier00f9d232016-02-11 14:25:08 +0000772 if (Offset == PairedOffset + OffsetStride) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000773 RtMI = &*Paired;
774 Rt2MI = &*I;
Chad Rosierb5933d72016-02-09 19:02:12 +0000775 // Here we swapped the assumption made for SExtIdx.
776 // I.e., we turn ldp I, Paired into ldp Paired, I.
777 // Update the index accordingly.
778 if (SExtIdx != -1)
779 SExtIdx = (SExtIdx + 1) % 2;
780 } else {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000781 RtMI = &*I;
782 Rt2MI = &*Paired;
Chad Rosierb5933d72016-02-09 19:02:12 +0000783 }
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000784 int OffsetImm = getLdStOffsetOp(*RtMI).getImm();
Chad Rosier00f9d232016-02-11 14:25:08 +0000785 // Scale the immediate offset, if necessary.
Chad Rosiere4e15ba2016-03-09 17:29:48 +0000786 if (TII->isUnscaledLdSt(RtMI->getOpcode())) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000787 assert(!(OffsetImm % getMemScale(*RtMI)) &&
Chad Rosier00f9d232016-02-11 14:25:08 +0000788 "Unscaled offset cannot be scaled.");
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000789 OffsetImm /= getMemScale(*RtMI);
Chad Rosier87e33412016-02-09 20:18:07 +0000790 }
Chad Rosierb5933d72016-02-09 19:02:12 +0000791
792 // Construct the new instruction.
793 MachineInstrBuilder MIB;
Chad Rosierc46ef882016-02-09 19:33:42 +0000794 DebugLoc DL = I->getDebugLoc();
795 MachineBasicBlock *MBB = I->getParent();
Matthias Braun2e8c11e2017-01-20 18:04:27 +0000796 MachineOperand RegOp0 = getLdStRegOp(*RtMI);
797 MachineOperand RegOp1 = getLdStRegOp(*Rt2MI);
798 // Kill flags may become invalid when moving stores for pairing.
799 if (RegOp0.isUse()) {
800 if (!MergeForward) {
801 // Clear kill flags on store if moving upwards. Example:
802 // STRWui %w0, ...
803 // USE %w1
804 // STRWui kill %w1 ; need to clear kill flag when moving STRWui upwards
805 RegOp0.setIsKill(false);
806 RegOp1.setIsKill(false);
807 } else {
808 // Clear kill flags of the first stores register. Example:
809 // STRWui %w1, ...
810 // USE kill %w1 ; need to clear kill flag when moving STRWui downwards
811 // STRW %w0
812 unsigned Reg = getLdStRegOp(*I).getReg();
813 for (MachineInstr &MI : make_range(std::next(I), Paired))
814 MI.clearRegisterKills(Reg, TRI);
815 }
816 }
Chad Rosierc46ef882016-02-09 19:33:42 +0000817 MIB = BuildMI(*MBB, InsertionPoint, DL, TII->get(getMatchingPairOpcode(Opc)))
Matthias Braun2e8c11e2017-01-20 18:04:27 +0000818 .add(RegOp0)
819 .add(RegOp1)
Diana Picus116bbab2017-01-13 09:58:52 +0000820 .add(BaseRegOp)
Chad Rosiere40b9512016-03-08 17:16:38 +0000821 .addImm(OffsetImm)
Chandler Carruthc73c0302018-08-16 21:30:05 +0000822 .cloneMergedMemRefs({&*I, &*Paired})
Francis Visoiu Mistrih084e7d82018-03-14 17:10:58 +0000823 .setMIFlags(I->mergeFlagsWith(*Paired));
Chad Rosierb5933d72016-02-09 19:02:12 +0000824
825 (void)MIB;
Tim Northover3b0846e2014-05-24 12:50:23 +0000826
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000827 LLVM_DEBUG(
828 dbgs() << "Creating pair load/store. Replacing instructions:\n ");
829 LLVM_DEBUG(I->print(dbgs()));
830 LLVM_DEBUG(dbgs() << " ");
831 LLVM_DEBUG(Paired->print(dbgs()));
832 LLVM_DEBUG(dbgs() << " with instruction:\n ");
Quentin Colombet66b61632015-03-06 22:42:10 +0000833 if (SExtIdx != -1) {
834 // Generate the sign extension for the proper result of the ldp.
835 // I.e., with X1, that would be:
Francis Visoiu Mistriha8a83d12017-12-07 10:40:31 +0000836 // %w1 = KILL %w1, implicit-def %x1
837 // %x1 = SBFMXri killed %x1, 0, 31
Quentin Colombet66b61632015-03-06 22:42:10 +0000838 MachineOperand &DstMO = MIB->getOperand(SExtIdx);
839 // Right now, DstMO has the extended register, since it comes from an
840 // extended opcode.
841 unsigned DstRegX = DstMO.getReg();
842 // Get the W variant of that register.
843 unsigned DstRegW = TRI->getSubReg(DstRegX, AArch64::sub_32);
844 // Update the result of LDP to use the W instead of the X variant.
845 DstMO.setReg(DstRegW);
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000846 LLVM_DEBUG(((MachineInstr *)MIB)->print(dbgs()));
847 LLVM_DEBUG(dbgs() << "\n");
Quentin Colombet66b61632015-03-06 22:42:10 +0000848 // Make the machine verifier happy by providing a definition for
849 // the X register.
850 // Insert this definition right after the generated LDP, i.e., before
851 // InsertionPoint.
852 MachineInstrBuilder MIBKill =
Chad Rosierc46ef882016-02-09 19:33:42 +0000853 BuildMI(*MBB, InsertionPoint, DL, TII->get(TargetOpcode::KILL), DstRegW)
Quentin Colombet66b61632015-03-06 22:42:10 +0000854 .addReg(DstRegW)
855 .addReg(DstRegX, RegState::Define);
856 MIBKill->getOperand(2).setImplicit();
857 // Create the sign extension.
858 MachineInstrBuilder MIBSXTW =
Chad Rosierc46ef882016-02-09 19:33:42 +0000859 BuildMI(*MBB, InsertionPoint, DL, TII->get(AArch64::SBFMXri), DstRegX)
Quentin Colombet66b61632015-03-06 22:42:10 +0000860 .addReg(DstRegX)
861 .addImm(0)
862 .addImm(31);
863 (void)MIBSXTW;
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000864 LLVM_DEBUG(dbgs() << " Extend operand:\n ");
865 LLVM_DEBUG(((MachineInstr *)MIBSXTW)->print(dbgs()));
Quentin Colombet66b61632015-03-06 22:42:10 +0000866 } else {
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000867 LLVM_DEBUG(((MachineInstr *)MIB)->print(dbgs()));
Quentin Colombet66b61632015-03-06 22:42:10 +0000868 }
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000869 LLVM_DEBUG(dbgs() << "\n");
Tim Northover3b0846e2014-05-24 12:50:23 +0000870
871 // Erase the old instructions.
872 I->eraseFromParent();
873 Paired->eraseFromParent();
874
875 return NextI;
876}
877
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000878MachineBasicBlock::iterator
879AArch64LoadStoreOpt::promoteLoadFromStore(MachineBasicBlock::iterator LoadI,
880 MachineBasicBlock::iterator StoreI) {
881 MachineBasicBlock::iterator NextI = LoadI;
882 ++NextI;
883
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000884 int LoadSize = getMemScale(*LoadI);
885 int StoreSize = getMemScale(*StoreI);
886 unsigned LdRt = getLdStRegOp(*LoadI).getReg();
Florian Hahn80e48512017-06-21 08:47:23 +0000887 const MachineOperand &StMO = getLdStRegOp(*StoreI);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000888 unsigned StRt = getLdStRegOp(*StoreI).getReg();
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000889 bool IsStoreXReg = TRI->getRegClass(AArch64::GPR64RegClassID)->contains(StRt);
890
891 assert((IsStoreXReg ||
892 TRI->getRegClass(AArch64::GPR32RegClassID)->contains(StRt)) &&
893 "Unexpected RegClass");
894
895 MachineInstr *BitExtMI;
896 if (LoadSize == StoreSize && (LoadSize == 4 || LoadSize == 8)) {
897 // Remove the load, if the destination register of the loads is the same
898 // register for stored value.
899 if (StRt == LdRt && LoadSize == 8) {
Tim Northover9ac3e422017-06-26 18:49:25 +0000900 for (MachineInstr &MI : make_range(StoreI->getIterator(),
901 LoadI->getIterator())) {
902 if (MI.killsRegister(StRt, TRI)) {
903 MI.clearRegisterKills(StRt, TRI);
904 break;
905 }
906 }
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000907 LLVM_DEBUG(dbgs() << "Remove load instruction:\n ");
908 LLVM_DEBUG(LoadI->print(dbgs()));
909 LLVM_DEBUG(dbgs() << "\n");
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000910 LoadI->eraseFromParent();
911 return NextI;
912 }
913 // Replace the load with a mov if the load and store are in the same size.
914 BitExtMI =
915 BuildMI(*LoadI->getParent(), LoadI, LoadI->getDebugLoc(),
916 TII->get(IsStoreXReg ? AArch64::ORRXrs : AArch64::ORRWrs), LdRt)
917 .addReg(IsStoreXReg ? AArch64::XZR : AArch64::WZR)
Florian Hahn80e48512017-06-21 08:47:23 +0000918 .add(StMO)
Francis Visoiu Mistrih084e7d82018-03-14 17:10:58 +0000919 .addImm(AArch64_AM::getShifterImm(AArch64_AM::LSL, 0))
920 .setMIFlags(LoadI->getFlags());
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000921 } else {
922 // FIXME: Currently we disable this transformation in big-endian targets as
923 // performance and correctness are verified only in little-endian.
924 if (!Subtarget->isLittleEndian())
925 return NextI;
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +0000926 bool IsUnscaled = TII->isUnscaledLdSt(*LoadI);
927 assert(IsUnscaled == TII->isUnscaledLdSt(*StoreI) &&
Chad Rosiere4e15ba2016-03-09 17:29:48 +0000928 "Unsupported ld/st match");
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000929 assert(LoadSize <= StoreSize && "Invalid load size");
930 int UnscaledLdOffset = IsUnscaled
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000931 ? getLdStOffsetOp(*LoadI).getImm()
932 : getLdStOffsetOp(*LoadI).getImm() * LoadSize;
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000933 int UnscaledStOffset = IsUnscaled
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000934 ? getLdStOffsetOp(*StoreI).getImm()
935 : getLdStOffsetOp(*StoreI).getImm() * StoreSize;
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000936 int Width = LoadSize * 8;
937 int Immr = 8 * (UnscaledLdOffset - UnscaledStOffset);
938 int Imms = Immr + Width - 1;
939 unsigned DestReg = IsStoreXReg
940 ? TRI->getMatchingSuperReg(LdRt, AArch64::sub_32,
941 &AArch64::GPR64RegClass)
942 : LdRt;
943
944 assert((UnscaledLdOffset >= UnscaledStOffset &&
945 (UnscaledLdOffset + LoadSize) <= UnscaledStOffset + StoreSize) &&
946 "Invalid offset");
947
948 Immr = 8 * (UnscaledLdOffset - UnscaledStOffset);
949 Imms = Immr + Width - 1;
950 if (UnscaledLdOffset == UnscaledStOffset) {
951 uint32_t AndMaskEncoded = ((IsStoreXReg ? 1 : 0) << 12) // N
952 | ((Immr) << 6) // immr
953 | ((Imms) << 0) // imms
954 ;
955
956 BitExtMI =
957 BuildMI(*LoadI->getParent(), LoadI, LoadI->getDebugLoc(),
958 TII->get(IsStoreXReg ? AArch64::ANDXri : AArch64::ANDWri),
959 DestReg)
Florian Hahn80e48512017-06-21 08:47:23 +0000960 .add(StMO)
Francis Visoiu Mistrih084e7d82018-03-14 17:10:58 +0000961 .addImm(AndMaskEncoded)
962 .setMIFlags(LoadI->getFlags());
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000963 } else {
964 BitExtMI =
965 BuildMI(*LoadI->getParent(), LoadI, LoadI->getDebugLoc(),
966 TII->get(IsStoreXReg ? AArch64::UBFMXri : AArch64::UBFMWri),
967 DestReg)
Florian Hahn80e48512017-06-21 08:47:23 +0000968 .add(StMO)
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000969 .addImm(Immr)
Francis Visoiu Mistrih084e7d82018-03-14 17:10:58 +0000970 .addImm(Imms)
971 .setMIFlags(LoadI->getFlags());
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000972 }
973 }
Matthias Braun76bb4132016-12-16 23:55:43 +0000974
Matthias Braund9a59a82017-02-17 23:15:03 +0000975 // Clear kill flags between store and load.
976 for (MachineInstr &MI : make_range(StoreI->getIterator(),
977 BitExtMI->getIterator()))
Florian Hahn8552e592017-06-21 09:51:52 +0000978 if (MI.killsRegister(StRt, TRI)) {
979 MI.clearRegisterKills(StRt, TRI);
980 break;
981 }
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000982
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000983 LLVM_DEBUG(dbgs() << "Promoting load by replacing :\n ");
984 LLVM_DEBUG(StoreI->print(dbgs()));
985 LLVM_DEBUG(dbgs() << " ");
986 LLVM_DEBUG(LoadI->print(dbgs()));
987 LLVM_DEBUG(dbgs() << " with instructions:\n ");
988 LLVM_DEBUG(StoreI->print(dbgs()));
989 LLVM_DEBUG(dbgs() << " ");
990 LLVM_DEBUG((BitExtMI)->print(dbgs()));
991 LLVM_DEBUG(dbgs() << "\n");
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000992
993 // Erase the old instructions.
994 LoadI->eraseFromParent();
995 return NextI;
996}
997
Tim Northover3b0846e2014-05-24 12:50:23 +0000998static bool inBoundsForPair(bool IsUnscaled, int Offset, int OffsetStride) {
Chad Rosier3dd0e942015-08-18 16:20:03 +0000999 // Convert the byte-offset used by unscaled into an "element" offset used
1000 // by the scaled pair load/store instructions.
Chad Rosier00f9d232016-02-11 14:25:08 +00001001 if (IsUnscaled) {
1002 // If the byte-offset isn't a multiple of the stride, there's no point
1003 // trying to match it.
1004 if (Offset % OffsetStride)
1005 return false;
Chad Rosier3dd0e942015-08-18 16:20:03 +00001006 Offset /= OffsetStride;
Chad Rosier00f9d232016-02-11 14:25:08 +00001007 }
Chad Rosier3dd0e942015-08-18 16:20:03 +00001008 return Offset <= 63 && Offset >= -64;
Tim Northover3b0846e2014-05-24 12:50:23 +00001009}
1010
1011// Do alignment, specialized to power of 2 and for signed ints,
1012// avoiding having to do a C-style cast from uint_64t to int when
Rui Ueyamada00f2f2016-01-14 21:06:47 +00001013// using alignTo from include/llvm/Support/MathExtras.h.
Tim Northover3b0846e2014-05-24 12:50:23 +00001014// FIXME: Move this function to include/MathExtras.h?
1015static int alignTo(int Num, int PowOf2) {
1016 return (Num + PowOf2 - 1) & ~(PowOf2 - 1);
1017}
1018
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +00001019static bool mayAlias(MachineInstr &MIa, MachineInstr &MIb,
Chad Rosiera69dcb62017-03-17 14:19:55 +00001020 AliasAnalysis *AA) {
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001021 // One of the instructions must modify memory.
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +00001022 if (!MIa.mayStore() && !MIb.mayStore())
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001023 return false;
1024
1025 // Both instructions must be memory operations.
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +00001026 if (!MIa.mayLoadOrStore() && !MIb.mayLoadOrStore())
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001027 return false;
1028
Chad Rosiera69dcb62017-03-17 14:19:55 +00001029 return MIa.mayAlias(AA, MIb, /*UseTBAA*/false);
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001030}
1031
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +00001032static bool mayAlias(MachineInstr &MIa,
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001033 SmallVectorImpl<MachineInstr *> &MemInsns,
Chad Rosiera69dcb62017-03-17 14:19:55 +00001034 AliasAnalysis *AA) {
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +00001035 for (MachineInstr *MIb : MemInsns)
Chad Rosiera69dcb62017-03-17 14:19:55 +00001036 if (mayAlias(MIa, *MIb, AA))
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001037 return true;
1038
1039 return false;
1040}
1041
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001042bool AArch64LoadStoreOpt::findMatchingStore(
1043 MachineBasicBlock::iterator I, unsigned Limit,
1044 MachineBasicBlock::iterator &StoreI) {
Jun Bum Lim633b2d82016-02-11 16:18:24 +00001045 MachineBasicBlock::iterator B = I->getParent()->begin();
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001046 MachineBasicBlock::iterator MBBI = I;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001047 MachineInstr &LoadMI = *I;
Chad Rosier5c6a66c2016-02-09 15:59:57 +00001048 unsigned BaseReg = getLdStBaseOp(LoadMI).getReg();
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001049
Jun Bum Lim633b2d82016-02-11 16:18:24 +00001050 // If the load is the first instruction in the block, there's obviously
1051 // not any matching store.
1052 if (MBBI == B)
1053 return false;
1054
Jun Bum Lim47aece12018-04-27 18:44:37 +00001055 // Track which register units have been modified and used between the first
1056 // insn and the second insn.
1057 ModifiedRegUnits.clear();
1058 UsedRegUnits.clear();
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001059
Jun Bum Lim633b2d82016-02-11 16:18:24 +00001060 unsigned Count = 0;
1061 do {
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001062 --MBBI;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001063 MachineInstr &MI = *MBBI;
Jun Bum Lim633b2d82016-02-11 16:18:24 +00001064
Geoff Berry4ff2e362016-07-21 15:20:25 +00001065 // Don't count transient instructions towards the search limit since there
1066 // may be different numbers of them if e.g. debug information is present.
1067 if (!MI.isTransient())
Jun Bum Lim633b2d82016-02-11 16:18:24 +00001068 ++Count;
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001069
1070 // If the load instruction reads directly from the address to which the
1071 // store instruction writes and the stored value is not modified, we can
1072 // promote the load. Since we do not handle stores with pre-/post-index,
1073 // it's unnecessary to check if BaseReg is modified by the store itself.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001074 if (MI.mayStore() && isMatchingStore(LoadMI, MI) &&
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001075 BaseReg == getLdStBaseOp(MI).getReg() &&
Chad Rosiere4e15ba2016-03-09 17:29:48 +00001076 isLdOffsetInRangeOfSt(LoadMI, MI, TII) &&
Jun Bum Lim47aece12018-04-27 18:44:37 +00001077 ModifiedRegUnits.available(getLdStRegOp(MI).getReg())) {
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001078 StoreI = MBBI;
1079 return true;
1080 }
1081
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001082 if (MI.isCall())
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001083 return false;
1084
Jun Bum Lim47aece12018-04-27 18:44:37 +00001085 // Update modified / uses register units.
1086 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits, UsedRegUnits, TRI);
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001087
1088 // Otherwise, if the base register is modified, we have no match, so
1089 // return early.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001090 if (!ModifiedRegUnits.available(BaseReg))
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001091 return false;
1092
1093 // If we encounter a store aliased with the load, return early.
Chad Rosiera69dcb62017-03-17 14:19:55 +00001094 if (MI.mayStore() && mayAlias(LoadMI, MI, AA))
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001095 return false;
Jun Bum Lim633b2d82016-02-11 16:18:24 +00001096 } while (MBBI != B && Count < Limit);
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001097 return false;
1098}
1099
Chad Rosierc5083c22016-06-10 20:47:14 +00001100// Returns true if FirstMI and MI are candidates for merging or pairing.
1101// Otherwise, returns false.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001102static bool areCandidatesToMergeOrPair(MachineInstr &FirstMI, MachineInstr &MI,
Chad Rosierc5083c22016-06-10 20:47:14 +00001103 LdStPairFlags &Flags,
1104 const AArch64InstrInfo *TII) {
1105 // If this is volatile or if pairing is suppressed, not a candidate.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001106 if (MI.hasOrderedMemoryRef() || TII->isLdStPairSuppressed(MI))
Chad Rosierc5083c22016-06-10 20:47:14 +00001107 return false;
1108
1109 // We should have already checked FirstMI for pair suppression and volatility.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001110 assert(!FirstMI.hasOrderedMemoryRef() &&
1111 !TII->isLdStPairSuppressed(FirstMI) &&
Chad Rosierc5083c22016-06-10 20:47:14 +00001112 "FirstMI shouldn't get here if either of these checks are true.");
1113
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001114 unsigned OpcA = FirstMI.getOpcode();
1115 unsigned OpcB = MI.getOpcode();
Chad Rosierc5083c22016-06-10 20:47:14 +00001116
Chad Rosierc3f6cb92016-02-10 19:45:48 +00001117 // Opcodes match: nothing more to check.
1118 if (OpcA == OpcB)
1119 return true;
1120
1121 // Try to match a sign-extended load/store with a zero-extended load/store.
1122 bool IsValidLdStrOpc, PairIsValidLdStrOpc;
1123 unsigned NonSExtOpc = getMatchingNonSExtOpcode(OpcA, &IsValidLdStrOpc);
1124 assert(IsValidLdStrOpc &&
1125 "Given Opc should be a Load or Store with an immediate");
1126 // OpcA will be the first instruction in the pair.
1127 if (NonSExtOpc == getMatchingNonSExtOpcode(OpcB, &PairIsValidLdStrOpc)) {
1128 Flags.setSExtIdx(NonSExtOpc == (unsigned)OpcA ? 1 : 0);
1129 return true;
1130 }
Chad Rosier00f9d232016-02-11 14:25:08 +00001131
Chad Rosierd6daac42016-11-07 15:27:22 +00001132 // If the second instruction isn't even a mergable/pairable load/store, bail
1133 // out.
Chad Rosier00f9d232016-02-11 14:25:08 +00001134 if (!PairIsValidLdStrOpc)
1135 return false;
1136
Chad Rosierd6daac42016-11-07 15:27:22 +00001137 // FIXME: We don't support merging narrow stores with mixed scaled/unscaled
1138 // offsets.
1139 if (isNarrowStore(OpcA) || isNarrowStore(OpcB))
Chad Rosier00f9d232016-02-11 14:25:08 +00001140 return false;
1141
1142 // Try to match an unscaled load/store with a scaled load/store.
Chad Rosiere4e15ba2016-03-09 17:29:48 +00001143 return TII->isUnscaledLdSt(OpcA) != TII->isUnscaledLdSt(OpcB) &&
Chad Rosier00f9d232016-02-11 14:25:08 +00001144 getMatchingPairOpcode(OpcA) == getMatchingPairOpcode(OpcB);
1145
1146 // FIXME: Can we also match a mixed sext/zext unscaled/scaled pair?
Chad Rosierc3f6cb92016-02-10 19:45:48 +00001147}
1148
Chad Rosier9f4ec2e2016-02-10 18:49:28 +00001149/// Scan the instructions looking for a load/store that can be combined with the
1150/// current instruction into a wider equivalent or a load/store pair.
Tim Northover3b0846e2014-05-24 12:50:23 +00001151MachineBasicBlock::iterator
1152AArch64LoadStoreOpt::findMatchingInsn(MachineBasicBlock::iterator I,
Jun Bum Limcf974432016-03-31 14:47:24 +00001153 LdStPairFlags &Flags, unsigned Limit,
1154 bool FindNarrowMerge) {
Tim Northover3b0846e2014-05-24 12:50:23 +00001155 MachineBasicBlock::iterator E = I->getParent()->end();
1156 MachineBasicBlock::iterator MBBI = I;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001157 MachineInstr &FirstMI = *I;
Tim Northover3b0846e2014-05-24 12:50:23 +00001158 ++MBBI;
1159
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001160 bool MayLoad = FirstMI.mayLoad();
1161 bool IsUnscaled = TII->isUnscaledLdSt(FirstMI);
Chad Rosierf77e9092015-08-06 15:50:12 +00001162 unsigned Reg = getLdStRegOp(FirstMI).getReg();
1163 unsigned BaseReg = getLdStBaseOp(FirstMI).getReg();
1164 int Offset = getLdStOffsetOp(FirstMI).getImm();
Chad Rosierf11d0402015-10-01 18:17:12 +00001165 int OffsetStride = IsUnscaled ? getMemScale(FirstMI) : 1;
Jun Bum Lim397eb7b2016-02-12 15:25:39 +00001166 bool IsPromotableZeroStore = isPromotableZeroStoreInst(FirstMI);
Tim Northover3b0846e2014-05-24 12:50:23 +00001167
Jun Bum Lim47aece12018-04-27 18:44:37 +00001168 // Track which register units have been modified and used between the first
1169 // insn (inclusive) and the second insn.
1170 ModifiedRegUnits.clear();
1171 UsedRegUnits.clear();
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001172
1173 // Remember any instructions that read/write memory between FirstMI and MI.
1174 SmallVector<MachineInstr *, 4> MemInsns;
1175
Tim Northover3b0846e2014-05-24 12:50:23 +00001176 for (unsigned Count = 0; MBBI != E && Count < Limit; ++MBBI) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001177 MachineInstr &MI = *MBBI;
Tim Northover3b0846e2014-05-24 12:50:23 +00001178
Geoff Berry4ff2e362016-07-21 15:20:25 +00001179 // Don't count transient instructions towards the search limit since there
1180 // may be different numbers of them if e.g. debug information is present.
1181 if (!MI.isTransient())
1182 ++Count;
Tim Northover3b0846e2014-05-24 12:50:23 +00001183
Chad Rosier18896c02016-02-04 16:01:40 +00001184 Flags.setSExtIdx(-1);
Chad Rosierc5083c22016-06-10 20:47:14 +00001185 if (areCandidatesToMergeOrPair(FirstMI, MI, Flags, TII) &&
Chad Rosierc3f6cb92016-02-10 19:45:48 +00001186 getLdStOffsetOp(MI).isImm()) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001187 assert(MI.mayLoadOrStore() && "Expected memory operation.");
Tim Northover3b0846e2014-05-24 12:50:23 +00001188 // If we've found another instruction with the same opcode, check to see
1189 // if the base and offset are compatible with our starting instruction.
1190 // These instructions all have scaled immediate operands, so we just
1191 // check for +1/-1. Make sure to check the new instruction offset is
1192 // actually an immediate and not a symbolic reference destined for
1193 // a relocation.
Chad Rosierf77e9092015-08-06 15:50:12 +00001194 unsigned MIBaseReg = getLdStBaseOp(MI).getReg();
1195 int MIOffset = getLdStOffsetOp(MI).getImm();
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001196 bool MIIsUnscaled = TII->isUnscaledLdSt(MI);
Chad Rosier00f9d232016-02-11 14:25:08 +00001197 if (IsUnscaled != MIIsUnscaled) {
1198 // We're trying to pair instructions that differ in how they are scaled.
1199 // If FirstMI is scaled then scale the offset of MI accordingly.
1200 // Otherwise, do the opposite (i.e., make MI's offset unscaled).
1201 int MemSize = getMemScale(MI);
1202 if (MIIsUnscaled) {
1203 // If the unscaled offset isn't a multiple of the MemSize, we can't
1204 // pair the operations together: bail and keep looking.
Eli Friedmanf184e4b2016-08-12 20:39:51 +00001205 if (MIOffset % MemSize) {
Jun Bum Lim47aece12018-04-27 18:44:37 +00001206 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits,
1207 UsedRegUnits, TRI);
Eli Friedmanf184e4b2016-08-12 20:39:51 +00001208 MemInsns.push_back(&MI);
Chad Rosier00f9d232016-02-11 14:25:08 +00001209 continue;
Eli Friedmanf184e4b2016-08-12 20:39:51 +00001210 }
Chad Rosier00f9d232016-02-11 14:25:08 +00001211 MIOffset /= MemSize;
1212 } else {
1213 MIOffset *= MemSize;
1214 }
1215 }
1216
Tim Northover3b0846e2014-05-24 12:50:23 +00001217 if (BaseReg == MIBaseReg && ((Offset == MIOffset + OffsetStride) ||
1218 (Offset + OffsetStride == MIOffset))) {
1219 int MinOffset = Offset < MIOffset ? Offset : MIOffset;
Jun Bum Limcf974432016-03-31 14:47:24 +00001220 if (FindNarrowMerge) {
Jun Bum Lim80ec0d32015-11-20 21:14:07 +00001221 // If the alignment requirements of the scaled wide load/store
Jun Bum Limcf974432016-03-31 14:47:24 +00001222 // instruction can't express the offset of the scaled narrow input,
1223 // bail and keep looking. For promotable zero stores, allow only when
1224 // the stored value is the same (i.e., WZR).
1225 if ((!IsUnscaled && alignTo(MinOffset, 2) != MinOffset) ||
1226 (IsPromotableZeroStore && Reg != getLdStRegOp(MI).getReg())) {
Jun Bum Lim47aece12018-04-27 18:44:37 +00001227 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits,
1228 UsedRegUnits, TRI);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001229 MemInsns.push_back(&MI);
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001230 continue;
1231 }
1232 } else {
Chad Rosierd1f6c842016-06-10 20:49:18 +00001233 // Pairwise instructions have a 7-bit signed offset field. Single
1234 // insns have a 12-bit unsigned offset field. If the resultant
1235 // immediate offset of merging these instructions is out of range for
1236 // a pairwise instruction, bail and keep looking.
Jun Bum Limcf974432016-03-31 14:47:24 +00001237 if (!inBoundsForPair(IsUnscaled, MinOffset, OffsetStride)) {
Jun Bum Lim47aece12018-04-27 18:44:37 +00001238 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits,
1239 UsedRegUnits, TRI);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001240 MemInsns.push_back(&MI);
Jun Bum Limcf974432016-03-31 14:47:24 +00001241 continue;
1242 }
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001243 // If the alignment requirements of the paired (scaled) instruction
1244 // can't express the offset of the unscaled input, bail and keep
1245 // looking.
1246 if (IsUnscaled && (alignTo(MinOffset, OffsetStride) != MinOffset)) {
Jun Bum Lim47aece12018-04-27 18:44:37 +00001247 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits,
1248 UsedRegUnits, TRI);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001249 MemInsns.push_back(&MI);
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001250 continue;
1251 }
Tim Northover3b0846e2014-05-24 12:50:23 +00001252 }
1253 // If the destination register of the loads is the same register, bail
1254 // and keep looking. A load-pair instruction with both destination
1255 // registers the same is UNPREDICTABLE and will result in an exception.
Jun Bum Limcf974432016-03-31 14:47:24 +00001256 if (MayLoad && Reg == getLdStRegOp(MI).getReg()) {
Jun Bum Lim47aece12018-04-27 18:44:37 +00001257 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits, UsedRegUnits,
1258 TRI);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001259 MemInsns.push_back(&MI);
Tim Northover3b0846e2014-05-24 12:50:23 +00001260 continue;
1261 }
1262
1263 // If the Rt of the second instruction was not modified or used between
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001264 // the two instructions and none of the instructions between the second
1265 // and first alias with the second, we can combine the second into the
1266 // first.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001267 if (ModifiedRegUnits.available(getLdStRegOp(MI).getReg()) &&
1268 !(MI.mayLoad() &&
1269 !UsedRegUnits.available(getLdStRegOp(MI).getReg())) &&
Chad Rosiera69dcb62017-03-17 14:19:55 +00001270 !mayAlias(MI, MemInsns, AA)) {
Chad Rosier96a18a92015-07-21 17:42:04 +00001271 Flags.setMergeForward(false);
Tim Northover3b0846e2014-05-24 12:50:23 +00001272 return MBBI;
1273 }
1274
1275 // Likewise, if the Rt of the first instruction is not modified or used
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001276 // between the two instructions and none of the instructions between the
1277 // first and the second alias with the first, we can combine the first
1278 // into the second.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001279 if (ModifiedRegUnits.available(getLdStRegOp(FirstMI).getReg()) &&
1280 !(MayLoad &&
1281 !UsedRegUnits.available(getLdStRegOp(FirstMI).getReg())) &&
Chad Rosiera69dcb62017-03-17 14:19:55 +00001282 !mayAlias(FirstMI, MemInsns, AA)) {
Chad Rosier96a18a92015-07-21 17:42:04 +00001283 Flags.setMergeForward(true);
Tim Northover3b0846e2014-05-24 12:50:23 +00001284 return MBBI;
1285 }
1286 // Unable to combine these instructions due to interference in between.
1287 // Keep looking.
1288 }
1289 }
1290
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001291 // If the instruction wasn't a matching load or store. Stop searching if we
1292 // encounter a call instruction that might modify memory.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001293 if (MI.isCall())
Tim Northover3b0846e2014-05-24 12:50:23 +00001294 return E;
1295
Jun Bum Lim47aece12018-04-27 18:44:37 +00001296 // Update modified / uses register units.
1297 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits, UsedRegUnits, TRI);
Tim Northover3b0846e2014-05-24 12:50:23 +00001298
1299 // Otherwise, if the base register is modified, we have no match, so
1300 // return early.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001301 if (!ModifiedRegUnits.available(BaseReg))
Tim Northover3b0846e2014-05-24 12:50:23 +00001302 return E;
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001303
1304 // Update list of instructions that read/write memory.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001305 if (MI.mayLoadOrStore())
1306 MemInsns.push_back(&MI);
Tim Northover3b0846e2014-05-24 12:50:23 +00001307 }
1308 return E;
1309}
1310
1311MachineBasicBlock::iterator
Chad Rosier2dfd3542015-09-23 13:51:44 +00001312AArch64LoadStoreOpt::mergeUpdateInsn(MachineBasicBlock::iterator I,
1313 MachineBasicBlock::iterator Update,
1314 bool IsPreIdx) {
Tim Northover3b0846e2014-05-24 12:50:23 +00001315 assert((Update->getOpcode() == AArch64::ADDXri ||
1316 Update->getOpcode() == AArch64::SUBXri) &&
1317 "Unexpected base register update instruction to merge!");
1318 MachineBasicBlock::iterator NextI = I;
1319 // Return the instruction following the merged instruction, which is
1320 // the instruction following our unmerged load. Unless that's the add/sub
1321 // instruction we're merging, in which case it's the one after that.
1322 if (++NextI == Update)
1323 ++NextI;
1324
1325 int Value = Update->getOperand(2).getImm();
1326 assert(AArch64_AM::getShiftValue(Update->getOperand(3).getImm()) == 0 &&
Chad Rosier2dfd3542015-09-23 13:51:44 +00001327 "Can't merge 1 << 12 offset into pre-/post-indexed load / store");
Tim Northover3b0846e2014-05-24 12:50:23 +00001328 if (Update->getOpcode() == AArch64::SUBXri)
1329 Value = -Value;
1330
Chad Rosier2dfd3542015-09-23 13:51:44 +00001331 unsigned NewOpc = IsPreIdx ? getPreIndexedOpcode(I->getOpcode())
1332 : getPostIndexedOpcode(I->getOpcode());
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001333 MachineInstrBuilder MIB;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001334 if (!isPairedLdSt(*I)) {
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001335 // Non-paired instruction.
1336 MIB = BuildMI(*I->getParent(), I, I->getDebugLoc(), TII->get(NewOpc))
Diana Picus116bbab2017-01-13 09:58:52 +00001337 .add(getLdStRegOp(*Update))
1338 .add(getLdStRegOp(*I))
1339 .add(getLdStBaseOp(*I))
Chad Rosier3ada75f2016-01-28 15:38:24 +00001340 .addImm(Value)
Chandler Carruthc73c0302018-08-16 21:30:05 +00001341 .setMemRefs(I->memoperands())
Francis Visoiu Mistrih084e7d82018-03-14 17:10:58 +00001342 .setMIFlags(I->mergeFlagsWith(*Update));
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001343 } else {
1344 // Paired instruction.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001345 int Scale = getMemScale(*I);
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001346 MIB = BuildMI(*I->getParent(), I, I->getDebugLoc(), TII->get(NewOpc))
Diana Picus116bbab2017-01-13 09:58:52 +00001347 .add(getLdStRegOp(*Update))
1348 .add(getLdStRegOp(*I, 0))
1349 .add(getLdStRegOp(*I, 1))
1350 .add(getLdStBaseOp(*I))
Chad Rosier3ada75f2016-01-28 15:38:24 +00001351 .addImm(Value / Scale)
Chandler Carruthc73c0302018-08-16 21:30:05 +00001352 .setMemRefs(I->memoperands())
Francis Visoiu Mistrih084e7d82018-03-14 17:10:58 +00001353 .setMIFlags(I->mergeFlagsWith(*Update));
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001354 }
Tim Northover3b0846e2014-05-24 12:50:23 +00001355 (void)MIB;
1356
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001357 if (IsPreIdx) {
1358 ++NumPreFolded;
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001359 LLVM_DEBUG(dbgs() << "Creating pre-indexed load/store.");
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001360 } else {
1361 ++NumPostFolded;
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001362 LLVM_DEBUG(dbgs() << "Creating post-indexed load/store.");
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001363 }
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001364 LLVM_DEBUG(dbgs() << " Replacing instructions:\n ");
1365 LLVM_DEBUG(I->print(dbgs()));
1366 LLVM_DEBUG(dbgs() << " ");
1367 LLVM_DEBUG(Update->print(dbgs()));
1368 LLVM_DEBUG(dbgs() << " with instruction:\n ");
1369 LLVM_DEBUG(((MachineInstr *)MIB)->print(dbgs()));
1370 LLVM_DEBUG(dbgs() << "\n");
Tim Northover3b0846e2014-05-24 12:50:23 +00001371
1372 // Erase the old instructions for the block.
1373 I->eraseFromParent();
1374 Update->eraseFromParent();
1375
1376 return NextI;
1377}
1378
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001379bool AArch64LoadStoreOpt::isMatchingUpdateInsn(MachineInstr &MemMI,
1380 MachineInstr &MI,
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001381 unsigned BaseReg, int Offset) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001382 switch (MI.getOpcode()) {
Tim Northover3b0846e2014-05-24 12:50:23 +00001383 default:
1384 break;
1385 case AArch64::SUBXri:
Tim Northover3b0846e2014-05-24 12:50:23 +00001386 case AArch64::ADDXri:
1387 // Make sure it's a vanilla immediate operand, not a relocation or
1388 // anything else we can't handle.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001389 if (!MI.getOperand(2).isImm())
Tim Northover3b0846e2014-05-24 12:50:23 +00001390 break;
1391 // Watch out for 1 << 12 shifted value.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001392 if (AArch64_AM::getShiftValue(MI.getOperand(3).getImm()))
Tim Northover3b0846e2014-05-24 12:50:23 +00001393 break;
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001394
1395 // The update instruction source and destination register must be the
1396 // same as the load/store base register.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001397 if (MI.getOperand(0).getReg() != BaseReg ||
1398 MI.getOperand(1).getReg() != BaseReg)
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001399 break;
1400
1401 bool IsPairedInsn = isPairedLdSt(MemMI);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001402 int UpdateOffset = MI.getOperand(2).getImm();
Eli Friedman8585e9d2016-08-12 20:28:02 +00001403 if (MI.getOpcode() == AArch64::SUBXri)
1404 UpdateOffset = -UpdateOffset;
1405
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001406 // For non-paired load/store instructions, the immediate must fit in a
1407 // signed 9-bit integer.
1408 if (!IsPairedInsn && (UpdateOffset > 255 || UpdateOffset < -256))
1409 break;
1410
1411 // For paired load/store instructions, the immediate must be a multiple of
1412 // the scaling factor. The scaled offset must also fit into a signed 7-bit
1413 // integer.
1414 if (IsPairedInsn) {
Chad Rosier32d4d372015-09-29 16:07:32 +00001415 int Scale = getMemScale(MemMI);
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001416 if (UpdateOffset % Scale != 0)
1417 break;
1418
1419 int ScaledOffset = UpdateOffset / Scale;
Eli Friedman8585e9d2016-08-12 20:28:02 +00001420 if (ScaledOffset > 63 || ScaledOffset < -64)
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001421 break;
Tim Northover3b0846e2014-05-24 12:50:23 +00001422 }
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001423
1424 // If we have a non-zero Offset, we check that it matches the amount
1425 // we're adding to the register.
Eli Friedman8585e9d2016-08-12 20:28:02 +00001426 if (!Offset || Offset == UpdateOffset)
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001427 return true;
Tim Northover3b0846e2014-05-24 12:50:23 +00001428 break;
1429 }
1430 return false;
1431}
1432
1433MachineBasicBlock::iterator AArch64LoadStoreOpt::findMatchingUpdateInsnForward(
Chad Rosier35706ad2016-02-04 21:26:02 +00001434 MachineBasicBlock::iterator I, int UnscaledOffset, unsigned Limit) {
Tim Northover3b0846e2014-05-24 12:50:23 +00001435 MachineBasicBlock::iterator E = I->getParent()->end();
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001436 MachineInstr &MemMI = *I;
Tim Northover3b0846e2014-05-24 12:50:23 +00001437 MachineBasicBlock::iterator MBBI = I;
Tim Northover3b0846e2014-05-24 12:50:23 +00001438
Chad Rosierf77e9092015-08-06 15:50:12 +00001439 unsigned BaseReg = getLdStBaseOp(MemMI).getReg();
Chad Rosier0b15e7c2015-10-01 13:33:31 +00001440 int MIUnscaledOffset = getLdStOffsetOp(MemMI).getImm() * getMemScale(MemMI);
Tim Northover3b0846e2014-05-24 12:50:23 +00001441
Chad Rosierb7c5b912015-10-01 13:43:05 +00001442 // Scan forward looking for post-index opportunities. Updating instructions
1443 // can't be formed if the memory instruction doesn't have the offset we're
1444 // looking for.
1445 if (MIUnscaledOffset != UnscaledOffset)
1446 return E;
1447
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001448 // If the base register overlaps a destination register, we can't
Tim Northover3b0846e2014-05-24 12:50:23 +00001449 // merge the update.
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001450 bool IsPairedInsn = isPairedLdSt(MemMI);
1451 for (unsigned i = 0, e = IsPairedInsn ? 2 : 1; i != e; ++i) {
1452 unsigned DestReg = getLdStRegOp(MemMI, i).getReg();
1453 if (DestReg == BaseReg || TRI->isSubRegister(BaseReg, DestReg))
1454 return E;
1455 }
Tim Northover3b0846e2014-05-24 12:50:23 +00001456
Jun Bum Lim47aece12018-04-27 18:44:37 +00001457 // Track which register units have been modified and used between the first
1458 // insn (inclusive) and the second insn.
1459 ModifiedRegUnits.clear();
1460 UsedRegUnits.clear();
Tim Northover3b0846e2014-05-24 12:50:23 +00001461 ++MBBI;
Chad Rosier35706ad2016-02-04 21:26:02 +00001462 for (unsigned Count = 0; MBBI != E && Count < Limit; ++MBBI) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001463 MachineInstr &MI = *MBBI;
Tim Northover3b0846e2014-05-24 12:50:23 +00001464
Geoff Berry4ff2e362016-07-21 15:20:25 +00001465 // Don't count transient instructions towards the search limit since there
1466 // may be different numbers of them if e.g. debug information is present.
1467 if (!MI.isTransient())
1468 ++Count;
Chad Rosier35706ad2016-02-04 21:26:02 +00001469
Tim Northover3b0846e2014-05-24 12:50:23 +00001470 // If we found a match, return it.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001471 if (isMatchingUpdateInsn(*I, MI, BaseReg, UnscaledOffset))
Tim Northover3b0846e2014-05-24 12:50:23 +00001472 return MBBI;
1473
1474 // Update the status of what the instruction clobbered and used.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001475 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits, UsedRegUnits, TRI);
Tim Northover3b0846e2014-05-24 12:50:23 +00001476
1477 // Otherwise, if the base register is used or modified, we have no match, so
1478 // return early.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001479 if (!ModifiedRegUnits.available(BaseReg) ||
1480 !UsedRegUnits.available(BaseReg))
Tim Northover3b0846e2014-05-24 12:50:23 +00001481 return E;
1482 }
1483 return E;
1484}
1485
1486MachineBasicBlock::iterator AArch64LoadStoreOpt::findMatchingUpdateInsnBackward(
Chad Rosier35706ad2016-02-04 21:26:02 +00001487 MachineBasicBlock::iterator I, unsigned Limit) {
Tim Northover3b0846e2014-05-24 12:50:23 +00001488 MachineBasicBlock::iterator B = I->getParent()->begin();
1489 MachineBasicBlock::iterator E = I->getParent()->end();
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001490 MachineInstr &MemMI = *I;
Tim Northover3b0846e2014-05-24 12:50:23 +00001491 MachineBasicBlock::iterator MBBI = I;
Tim Northover3b0846e2014-05-24 12:50:23 +00001492
Chad Rosierf77e9092015-08-06 15:50:12 +00001493 unsigned BaseReg = getLdStBaseOp(MemMI).getReg();
1494 int Offset = getLdStOffsetOp(MemMI).getImm();
Tim Northover3b0846e2014-05-24 12:50:23 +00001495
1496 // If the load/store is the first instruction in the block, there's obviously
1497 // not any matching update. Ditto if the memory offset isn't zero.
1498 if (MBBI == B || Offset != 0)
1499 return E;
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001500 // If the base register overlaps a destination register, we can't
Tim Northover3b0846e2014-05-24 12:50:23 +00001501 // merge the update.
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001502 bool IsPairedInsn = isPairedLdSt(MemMI);
1503 for (unsigned i = 0, e = IsPairedInsn ? 2 : 1; i != e; ++i) {
1504 unsigned DestReg = getLdStRegOp(MemMI, i).getReg();
1505 if (DestReg == BaseReg || TRI->isSubRegister(BaseReg, DestReg))
1506 return E;
1507 }
Tim Northover3b0846e2014-05-24 12:50:23 +00001508
Jun Bum Lim47aece12018-04-27 18:44:37 +00001509 // Track which register units have been modified and used between the first
1510 // insn (inclusive) and the second insn.
1511 ModifiedRegUnits.clear();
1512 UsedRegUnits.clear();
Geoff Berry173b14d2016-02-09 20:47:21 +00001513 unsigned Count = 0;
1514 do {
1515 --MBBI;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001516 MachineInstr &MI = *MBBI;
Tim Northover3b0846e2014-05-24 12:50:23 +00001517
Geoff Berry4ff2e362016-07-21 15:20:25 +00001518 // Don't count transient instructions towards the search limit since there
1519 // may be different numbers of them if e.g. debug information is present.
1520 if (!MI.isTransient())
Geoff Berry173b14d2016-02-09 20:47:21 +00001521 ++Count;
Chad Rosier35706ad2016-02-04 21:26:02 +00001522
Tim Northover3b0846e2014-05-24 12:50:23 +00001523 // If we found a match, return it.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001524 if (isMatchingUpdateInsn(*I, MI, BaseReg, Offset))
Tim Northover3b0846e2014-05-24 12:50:23 +00001525 return MBBI;
1526
1527 // Update the status of what the instruction clobbered and used.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001528 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits, UsedRegUnits, TRI);
Tim Northover3b0846e2014-05-24 12:50:23 +00001529
1530 // Otherwise, if the base register is used or modified, we have no match, so
1531 // return early.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001532 if (!ModifiedRegUnits.available(BaseReg) ||
1533 !UsedRegUnits.available(BaseReg))
Tim Northover3b0846e2014-05-24 12:50:23 +00001534 return E;
Geoff Berry173b14d2016-02-09 20:47:21 +00001535 } while (MBBI != B && Count < Limit);
Tim Northover3b0846e2014-05-24 12:50:23 +00001536 return E;
1537}
1538
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001539bool AArch64LoadStoreOpt::tryToPromoteLoadFromStore(
1540 MachineBasicBlock::iterator &MBBI) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001541 MachineInstr &MI = *MBBI;
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001542 // If this is a volatile load, don't mess with it.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001543 if (MI.hasOrderedMemoryRef())
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001544 return false;
1545
1546 // Make sure this is a reg+imm.
1547 // FIXME: It is possible to extend it to handle reg+reg cases.
1548 if (!getLdStOffsetOp(MI).isImm())
1549 return false;
1550
Chad Rosier35706ad2016-02-04 21:26:02 +00001551 // Look backward up to LdStLimit instructions.
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001552 MachineBasicBlock::iterator StoreI;
Chad Rosier35706ad2016-02-04 21:26:02 +00001553 if (findMatchingStore(MBBI, LdStLimit, StoreI)) {
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001554 ++NumLoadsFromStoresPromoted;
1555 // Promote the load. Keeping the iterator straight is a
1556 // pain, so we let the merge routine tell us what the next instruction
1557 // is after it's done mucking about.
1558 MBBI = promoteLoadFromStore(MBBI, StoreI);
1559 return true;
1560 }
1561 return false;
1562}
1563
Chad Rosierd6daac42016-11-07 15:27:22 +00001564// Merge adjacent zero stores into a wider store.
1565bool AArch64LoadStoreOpt::tryToMergeZeroStInst(
Chad Rosier24c46ad2016-02-09 18:10:20 +00001566 MachineBasicBlock::iterator &MBBI) {
Chad Rosierd6daac42016-11-07 15:27:22 +00001567 assert(isPromotableZeroStoreInst(*MBBI) && "Expected narrow store.");
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001568 MachineInstr &MI = *MBBI;
1569 MachineBasicBlock::iterator E = MI.getParent()->end();
Chad Rosier24c46ad2016-02-09 18:10:20 +00001570
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001571 if (!TII->isCandidateToMergeOrPair(MI))
Chad Rosier24c46ad2016-02-09 18:10:20 +00001572 return false;
1573
1574 // Look ahead up to LdStLimit instructions for a mergable instruction.
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001575 LdStPairFlags Flags;
Jun Bum Lim397eb7b2016-02-12 15:25:39 +00001576 MachineBasicBlock::iterator MergeMI =
Jun Bum Limcf974432016-03-31 14:47:24 +00001577 findMatchingInsn(MBBI, Flags, LdStLimit, /* FindNarrowMerge = */ true);
Chad Rosierd7363db2016-02-09 19:09:22 +00001578 if (MergeMI != E) {
Chad Rosierd6daac42016-11-07 15:27:22 +00001579 ++NumZeroStoresPromoted;
1580
Chad Rosier24c46ad2016-02-09 18:10:20 +00001581 // Keeping the iterator straight is a pain, so we let the merge routine tell
1582 // us what the next instruction is after it's done mucking about.
Chad Rosierd6daac42016-11-07 15:27:22 +00001583 MBBI = mergeNarrowZeroStores(MBBI, MergeMI, Flags);
Chad Rosier24c46ad2016-02-09 18:10:20 +00001584 return true;
1585 }
1586 return false;
1587}
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001588
Chad Rosier24c46ad2016-02-09 18:10:20 +00001589// Find loads and stores that can be merged into a single load or store pair
1590// instruction.
1591bool AArch64LoadStoreOpt::tryToPairLdStInst(MachineBasicBlock::iterator &MBBI) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001592 MachineInstr &MI = *MBBI;
1593 MachineBasicBlock::iterator E = MI.getParent()->end();
Chad Rosier24c46ad2016-02-09 18:10:20 +00001594
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001595 if (!TII->isCandidateToMergeOrPair(MI))
Chad Rosier24c46ad2016-02-09 18:10:20 +00001596 return false;
1597
Chad Rosierfc3bf1f2016-02-10 15:52:46 +00001598 // Early exit if the offset is not possible to match. (6 bits of positive
1599 // range, plus allow an extra one in case we find a later insn that matches
1600 // with Offset-1)
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001601 bool IsUnscaled = TII->isUnscaledLdSt(MI);
Chad Rosierfc3bf1f2016-02-10 15:52:46 +00001602 int Offset = getLdStOffsetOp(MI).getImm();
1603 int OffsetStride = IsUnscaled ? getMemScale(MI) : 1;
Nirav Dave0f9d1112017-01-04 21:21:46 +00001604 // Allow one more for offset.
1605 if (Offset > 0)
1606 Offset -= OffsetStride;
Chad Rosierfc3bf1f2016-02-10 15:52:46 +00001607 if (!inBoundsForPair(IsUnscaled, Offset, OffsetStride))
1608 return false;
1609
Chad Rosier24c46ad2016-02-09 18:10:20 +00001610 // Look ahead up to LdStLimit instructions for a pairable instruction.
1611 LdStPairFlags Flags;
Jun Bum Limcf974432016-03-31 14:47:24 +00001612 MachineBasicBlock::iterator Paired =
1613 findMatchingInsn(MBBI, Flags, LdStLimit, /* FindNarrowMerge = */ false);
Chad Rosier24c46ad2016-02-09 18:10:20 +00001614 if (Paired != E) {
1615 ++NumPairCreated;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001616 if (TII->isUnscaledLdSt(MI))
Chad Rosier24c46ad2016-02-09 18:10:20 +00001617 ++NumUnscaledPairCreated;
1618 // Keeping the iterator straight is a pain, so we let the merge routine tell
1619 // us what the next instruction is after it's done mucking about.
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001620 MBBI = mergePairedInsns(MBBI, Paired, Flags);
1621 return true;
1622 }
1623 return false;
1624}
1625
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001626bool AArch64LoadStoreOpt::tryToMergeLdStUpdate
1627 (MachineBasicBlock::iterator &MBBI) {
1628 MachineInstr &MI = *MBBI;
1629 MachineBasicBlock::iterator E = MI.getParent()->end();
1630 MachineBasicBlock::iterator Update;
1631
1632 // Look forward to try to form a post-index instruction. For example,
1633 // ldr x0, [x20]
1634 // add x20, x20, #32
1635 // merged into:
1636 // ldr x0, [x20], #32
1637 Update = findMatchingUpdateInsnForward(MBBI, 0, UpdateLimit);
1638 if (Update != E) {
1639 // Merge the update into the ld/st.
1640 MBBI = mergeUpdateInsn(MBBI, Update, /*IsPreIdx=*/false);
1641 return true;
1642 }
1643
1644 // Don't know how to handle unscaled pre/post-index versions below, so bail.
1645 if (TII->isUnscaledLdSt(MI.getOpcode()))
1646 return false;
1647
1648 // Look back to try to find a pre-index instruction. For example,
1649 // add x0, x0, #8
1650 // ldr x1, [x0]
1651 // merged into:
1652 // ldr x1, [x0, #8]!
1653 Update = findMatchingUpdateInsnBackward(MBBI, UpdateLimit);
1654 if (Update != E) {
1655 // Merge the update into the ld/st.
1656 MBBI = mergeUpdateInsn(MBBI, Update, /*IsPreIdx=*/true);
1657 return true;
1658 }
1659
1660 // The immediate in the load/store is scaled by the size of the memory
1661 // operation. The immediate in the add we're looking for,
1662 // however, is not, so adjust here.
1663 int UnscaledOffset = getLdStOffsetOp(MI).getImm() * getMemScale(MI);
1664
1665 // Look forward to try to find a post-index instruction. For example,
1666 // ldr x1, [x0, #64]
1667 // add x0, x0, #64
1668 // merged into:
1669 // ldr x1, [x0, #64]!
1670 Update = findMatchingUpdateInsnForward(MBBI, UnscaledOffset, UpdateLimit);
1671 if (Update != E) {
1672 // Merge the update into the ld/st.
1673 MBBI = mergeUpdateInsn(MBBI, Update, /*IsPreIdx=*/true);
1674 return true;
1675 }
1676
1677 return false;
1678}
1679
Jun Bum Lim22fe15e2015-11-06 16:27:47 +00001680bool AArch64LoadStoreOpt::optimizeBlock(MachineBasicBlock &MBB,
Chad Rosierd6daac42016-11-07 15:27:22 +00001681 bool EnableNarrowZeroStOpt) {
Tim Northover3b0846e2014-05-24 12:50:23 +00001682 bool Modified = false;
Chad Rosierdbdb1d62016-02-01 21:38:31 +00001683 // Four tranformations to do here:
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001684 // 1) Find loads that directly read from stores and promote them by
1685 // replacing with mov instructions. If the store is wider than the load,
1686 // the load will be replaced with a bitfield extract.
1687 // e.g.,
1688 // str w1, [x0, #4]
1689 // ldrh w2, [x0, #6]
1690 // ; becomes
1691 // str w1, [x0, #4]
NAKAMURA Takumife1202c2016-06-20 00:37:41 +00001692 // lsr w2, w1, #16
Tim Northover3b0846e2014-05-24 12:50:23 +00001693 for (MachineBasicBlock::iterator MBBI = MBB.begin(), E = MBB.end();
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001694 MBBI != E;) {
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001695 if (isPromotableLoadFromStore(*MBBI) && tryToPromoteLoadFromStore(MBBI))
1696 Modified = true;
1697 else
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001698 ++MBBI;
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001699 }
Chad Rosierd6daac42016-11-07 15:27:22 +00001700 // 2) Merge adjacent zero stores into a wider store.
Jun Bum Lim1de2d442016-02-05 20:02:03 +00001701 // e.g.,
1702 // strh wzr, [x0]
1703 // strh wzr, [x0, #2]
1704 // ; becomes
1705 // str wzr, [x0]
Chad Rosierd6daac42016-11-07 15:27:22 +00001706 // e.g.,
1707 // str wzr, [x0]
1708 // str wzr, [x0, #4]
1709 // ; becomes
1710 // str xzr, [x0]
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001711 if (EnableNarrowZeroStOpt)
1712 for (MachineBasicBlock::iterator MBBI = MBB.begin(), E = MBB.end();
1713 MBBI != E;) {
1714 if (isPromotableZeroStoreInst(*MBBI) && tryToMergeZeroStInst(MBBI))
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001715 Modified = true;
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001716 else
Jun Bum Lim33be4992016-05-06 15:08:57 +00001717 ++MBBI;
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001718 }
Chad Rosierdbdb1d62016-02-01 21:38:31 +00001719 // 3) Find loads and stores that can be merged into a single load or store
1720 // pair instruction.
1721 // e.g.,
1722 // ldr x0, [x2]
1723 // ldr x1, [x2, #8]
1724 // ; becomes
1725 // ldp x0, x1, [x2]
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001726 for (MachineBasicBlock::iterator MBBI = MBB.begin(), E = MBB.end();
Tim Northover3b0846e2014-05-24 12:50:23 +00001727 MBBI != E;) {
Geoff Berry22dfbc52016-08-12 15:26:00 +00001728 if (TII->isPairableLdStInst(*MBBI) && tryToPairLdStInst(MBBI))
1729 Modified = true;
1730 else
Tim Northover3b0846e2014-05-24 12:50:23 +00001731 ++MBBI;
Tim Northover3b0846e2014-05-24 12:50:23 +00001732 }
Chad Rosierdbdb1d62016-02-01 21:38:31 +00001733 // 4) Find base register updates that can be merged into the load or store
1734 // as a base-reg writeback.
1735 // e.g.,
1736 // ldr x0, [x2]
1737 // add x2, x2, #4
1738 // ; becomes
1739 // ldr x0, [x2], #4
Tim Northover3b0846e2014-05-24 12:50:23 +00001740 for (MachineBasicBlock::iterator MBBI = MBB.begin(), E = MBB.end();
1741 MBBI != E;) {
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001742 if (isMergeableLdStUpdate(*MBBI) && tryToMergeLdStUpdate(MBBI))
1743 Modified = true;
1744 else
Tim Northover3b0846e2014-05-24 12:50:23 +00001745 ++MBBI;
Tim Northover3b0846e2014-05-24 12:50:23 +00001746 }
1747
1748 return Modified;
1749}
1750
1751bool AArch64LoadStoreOpt::runOnMachineFunction(MachineFunction &Fn) {
Matthias Braunf1caa282017-12-15 22:22:58 +00001752 if (skipFunction(Fn.getFunction()))
Andrew Kaylor1ac98bb2016-04-25 21:58:52 +00001753 return false;
1754
Oliver Stannardd414c992015-11-10 11:04:18 +00001755 Subtarget = &static_cast<const AArch64Subtarget &>(Fn.getSubtarget());
1756 TII = static_cast<const AArch64InstrInfo *>(Subtarget->getInstrInfo());
1757 TRI = Subtarget->getRegisterInfo();
Chad Rosiera69dcb62017-03-17 14:19:55 +00001758 AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
Tim Northover3b0846e2014-05-24 12:50:23 +00001759
Jun Bum Lim47aece12018-04-27 18:44:37 +00001760 // Resize the modified and used register unit trackers. We do this once
1761 // per function and then clear the register units each time we optimize a load
1762 // or store.
1763 ModifiedRegUnits.init(*TRI);
1764 UsedRegUnits.init(*TRI);
Chad Rosierbba881e2016-02-02 15:02:30 +00001765
Tim Northover3b0846e2014-05-24 12:50:23 +00001766 bool Modified = false;
Chad Rosier10c7aaa2016-11-11 14:10:12 +00001767 bool enableNarrowZeroStOpt = !Subtarget->requiresStrictAlign();
Tim Northover3b0846e2014-05-24 12:50:23 +00001768 for (auto &MBB : Fn)
Chad Rosierd6daac42016-11-07 15:27:22 +00001769 Modified |= optimizeBlock(MBB, enableNarrowZeroStOpt);
Tim Northover3b0846e2014-05-24 12:50:23 +00001770
1771 return Modified;
1772}
1773
Chad Rosier8ade0342016-11-11 19:52:45 +00001774// FIXME: Do we need/want a pre-alloc pass like ARM has to try to keep loads and
1775// stores near one another? Note: The pre-RA instruction scheduler already has
1776// hooks to try and schedule pairable loads/stores together to improve pairing
1777// opportunities. Thus, pre-RA pairing pass may not be worth the effort.
Tim Northover3b0846e2014-05-24 12:50:23 +00001778
Chad Rosier3f8b09d2016-02-09 19:42:19 +00001779// FIXME: When pairing store instructions it's very possible for this pass to
1780// hoist a store with a KILL marker above another use (without a KILL marker).
1781// The resulting IR is invalid, but nothing uses the KILL markers after this
1782// pass, so it's never caused a problem in practice.
1783
Chad Rosier43f5c842015-08-05 12:40:13 +00001784/// createAArch64LoadStoreOptimizationPass - returns an instance of the
1785/// load / store optimization pass.
Tim Northover3b0846e2014-05-24 12:50:23 +00001786FunctionPass *llvm::createAArch64LoadStoreOptimizationPass() {
1787 return new AArch64LoadStoreOpt();
1788}