blob: 65b5f906e3f6480775ca014b5ce1be6c6b181e7f [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//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Tim Northover3b0846e2014-05-24 12:50:23 +00006//
7//===----------------------------------------------------------------------===//
8//
9// This file contains a pass that performs load / store related peephole
10// optimizations. This pass should be run after register allocation.
11//
12//===----------------------------------------------------------------------===//
13
14#include "AArch64InstrInfo.h"
Eric Christopherd9134482014-08-04 21:25:23 +000015#include "AArch64Subtarget.h"
Tim Northover3b0846e2014-05-24 12:50:23 +000016#include "MCTargetDesc/AArch64AddressingModes.h"
17#include "llvm/ADT/BitVector.h"
Chad Rosierce8e5ab2015-05-21 21:36:46 +000018#include "llvm/ADT/SmallVector.h"
Benjamin Kramer1f8930e2014-07-25 11:42:14 +000019#include "llvm/ADT/Statistic.h"
Eugene Zelenko11f69072017-01-25 00:29:26 +000020#include "llvm/ADT/StringRef.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000021#include "llvm/ADT/iterator_range.h"
Eugene Zelenko96d933d2017-07-25 23:51:02 +000022#include "llvm/Analysis/AliasAnalysis.h"
Tim Northover3b0846e2014-05-24 12:50:23 +000023#include "llvm/CodeGen/MachineBasicBlock.h"
Eugene Zelenko11f69072017-01-25 00:29:26 +000024#include "llvm/CodeGen/MachineFunction.h"
Tim Northover3b0846e2014-05-24 12:50:23 +000025#include "llvm/CodeGen/MachineFunctionPass.h"
26#include "llvm/CodeGen/MachineInstr.h"
27#include "llvm/CodeGen/MachineInstrBuilder.h"
Eugene Zelenko11f69072017-01-25 00:29:26 +000028#include "llvm/CodeGen/MachineOperand.h"
David Blaikieb3bde2e2017-11-17 01:07:10 +000029#include "llvm/CodeGen/TargetRegisterInfo.h"
Eugene Zelenko11f69072017-01-25 00:29:26 +000030#include "llvm/IR/DebugLoc.h"
31#include "llvm/MC/MCRegisterInfo.h"
32#include "llvm/Pass.h"
Tim Northover3b0846e2014-05-24 12:50:23 +000033#include "llvm/Support/CommandLine.h"
34#include "llvm/Support/Debug.h"
35#include "llvm/Support/ErrorHandling.h"
36#include "llvm/Support/raw_ostream.h"
Eugene Zelenko11f69072017-01-25 00:29:26 +000037#include <cassert>
38#include <cstdint>
39#include <iterator>
40#include <limits>
41
Tim Northover3b0846e2014-05-24 12:50:23 +000042using namespace llvm;
43
44#define DEBUG_TYPE "aarch64-ldst-opt"
45
Tim Northover3b0846e2014-05-24 12:50:23 +000046STATISTIC(NumPairCreated, "Number of load/store pair instructions generated");
47STATISTIC(NumPostFolded, "Number of post-index updates folded");
48STATISTIC(NumPreFolded, "Number of pre-index updates folded");
49STATISTIC(NumUnscaledPairCreated,
50 "Number of load/store from unscaled generated");
Jun Bum Lim80ec0d32015-11-20 21:14:07 +000051STATISTIC(NumZeroStoresPromoted, "Number of narrow zero stores promoted");
Jun Bum Lim6755c3b2015-12-22 16:36:16 +000052STATISTIC(NumLoadsFromStoresPromoted, "Number of loads from stores promoted");
Tim Northover3b0846e2014-05-24 12:50:23 +000053
Chad Rosier35706ad2016-02-04 21:26:02 +000054// The LdStLimit limits how far we search for load/store pairs.
55static cl::opt<unsigned> LdStLimit("aarch64-load-store-scan-limit",
Tilmann Scheller5d8d72c2014-06-04 12:40:35 +000056 cl::init(20), cl::Hidden);
Tim Northover3b0846e2014-05-24 12:50:23 +000057
Chad Rosier35706ad2016-02-04 21:26:02 +000058// The UpdateLimit limits how far we search for update instructions when we form
59// pre-/post-index instructions.
60static cl::opt<unsigned> UpdateLimit("aarch64-update-scan-limit", cl::init(100),
61 cl::Hidden);
62
Chad Rosier96530b32015-08-05 13:44:51 +000063#define AARCH64_LOAD_STORE_OPT_NAME "AArch64 load / store optimization pass"
64
Tim Northover3b0846e2014-05-24 12:50:23 +000065namespace {
Chad Rosier96a18a92015-07-21 17:42:04 +000066
Eugene Zelenko96d933d2017-07-25 23:51:02 +000067using LdStPairFlags = struct LdStPairFlags {
Chad Rosier96a18a92015-07-21 17:42:04 +000068 // If a matching instruction is found, MergeForward is set to true if the
69 // merge is to remove the first instruction and replace the second with
70 // a pair-wise insn, and false if the reverse is true.
Eugene Zelenko11f69072017-01-25 00:29:26 +000071 bool MergeForward = false;
Chad Rosier96a18a92015-07-21 17:42:04 +000072
73 // SExtIdx gives the index of the result of the load pair that must be
74 // extended. The value of SExtIdx assumes that the paired load produces the
75 // value in this order: (I, returned iterator), i.e., -1 means no value has
76 // to be extended, 0 means I, and 1 means the returned iterator.
Eugene Zelenko11f69072017-01-25 00:29:26 +000077 int SExtIdx = -1;
Chad Rosier96a18a92015-07-21 17:42:04 +000078
Eugene Zelenko11f69072017-01-25 00:29:26 +000079 LdStPairFlags() = default;
Chad Rosier96a18a92015-07-21 17:42:04 +000080
81 void setMergeForward(bool V = true) { MergeForward = V; }
82 bool getMergeForward() const { return MergeForward; }
83
84 void setSExtIdx(int V) { SExtIdx = V; }
85 int getSExtIdx() const { return SExtIdx; }
Eugene Zelenko96d933d2017-07-25 23:51:02 +000086};
Chad Rosier96a18a92015-07-21 17:42:04 +000087
Tim Northover3b0846e2014-05-24 12:50:23 +000088struct AArch64LoadStoreOpt : public MachineFunctionPass {
89 static char ID;
Eugene Zelenko11f69072017-01-25 00:29:26 +000090
Jun Bum Lim22fe15e2015-11-06 16:27:47 +000091 AArch64LoadStoreOpt() : MachineFunctionPass(ID) {
Chad Rosier96530b32015-08-05 13:44:51 +000092 initializeAArch64LoadStoreOptPass(*PassRegistry::getPassRegistry());
93 }
Tim Northover3b0846e2014-05-24 12:50:23 +000094
Chad Rosiera69dcb62017-03-17 14:19:55 +000095 AliasAnalysis *AA;
Tim Northover3b0846e2014-05-24 12:50:23 +000096 const AArch64InstrInfo *TII;
97 const TargetRegisterInfo *TRI;
Oliver Stannardd414c992015-11-10 11:04:18 +000098 const AArch64Subtarget *Subtarget;
Tim Northover3b0846e2014-05-24 12:50:23 +000099
Jun Bum Lim47aece12018-04-27 18:44:37 +0000100 // Track which register units have been modified and used.
101 LiveRegUnits ModifiedRegUnits, UsedRegUnits;
Chad Rosierbba881e2016-02-02 15:02:30 +0000102
Eugene Zelenko96d933d2017-07-25 23:51:02 +0000103 void getAnalysisUsage(AnalysisUsage &AU) const override {
Chad Rosiera69dcb62017-03-17 14:19:55 +0000104 AU.addRequired<AAResultsWrapperPass>();
105 MachineFunctionPass::getAnalysisUsage(AU);
106 }
107
Tim Northover3b0846e2014-05-24 12:50:23 +0000108 // Scan the instructions looking for a load/store that can be combined
109 // with the current instruction into a load/store pair.
110 // Return the matching instruction if one is found, else MBB->end().
Tim Northover3b0846e2014-05-24 12:50:23 +0000111 MachineBasicBlock::iterator findMatchingInsn(MachineBasicBlock::iterator I,
Chad Rosier96a18a92015-07-21 17:42:04 +0000112 LdStPairFlags &Flags,
Jun Bum Limcf974432016-03-31 14:47:24 +0000113 unsigned Limit,
114 bool FindNarrowMerge);
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000115
116 // Scan the instructions looking for a store that writes to the address from
117 // which the current load instruction reads. Return true if one is found.
118 bool findMatchingStore(MachineBasicBlock::iterator I, unsigned Limit,
119 MachineBasicBlock::iterator &StoreI);
120
Chad Rosierd6daac42016-11-07 15:27:22 +0000121 // Merge the two instructions indicated into a wider narrow store instruction.
Chad Rosierb5933d72016-02-09 19:02:12 +0000122 MachineBasicBlock::iterator
Chad Rosierd6daac42016-11-07 15:27:22 +0000123 mergeNarrowZeroStores(MachineBasicBlock::iterator I,
124 MachineBasicBlock::iterator MergeMI,
125 const LdStPairFlags &Flags);
Chad Rosierb5933d72016-02-09 19:02:12 +0000126
Tim Northover3b0846e2014-05-24 12:50:23 +0000127 // Merge the two instructions indicated into a single pair-wise instruction.
Tim Northover3b0846e2014-05-24 12:50:23 +0000128 MachineBasicBlock::iterator
129 mergePairedInsns(MachineBasicBlock::iterator I,
Chad Rosier96a18a92015-07-21 17:42:04 +0000130 MachineBasicBlock::iterator Paired,
Chad Rosierfe5399f2015-07-21 17:47:56 +0000131 const LdStPairFlags &Flags);
Tim Northover3b0846e2014-05-24 12:50:23 +0000132
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000133 // Promote the load that reads directly from the address stored to.
134 MachineBasicBlock::iterator
135 promoteLoadFromStore(MachineBasicBlock::iterator LoadI,
136 MachineBasicBlock::iterator StoreI);
137
Tim Northover3b0846e2014-05-24 12:50:23 +0000138 // Scan the instruction list to find a base register update that can
139 // be combined with the current instruction (a load or store) using
140 // pre or post indexed addressing with writeback. Scan forwards.
141 MachineBasicBlock::iterator
Chad Rosier234bf6f2016-01-18 21:56:40 +0000142 findMatchingUpdateInsnForward(MachineBasicBlock::iterator I,
Chad Rosier35706ad2016-02-04 21:26:02 +0000143 int UnscaledOffset, unsigned Limit);
Tim Northover3b0846e2014-05-24 12:50:23 +0000144
145 // Scan the instruction list to find a base register update that can
146 // be combined with the current instruction (a load or store) using
147 // pre or post indexed addressing with writeback. Scan backwards.
148 MachineBasicBlock::iterator
Chad Rosier35706ad2016-02-04 21:26:02 +0000149 findMatchingUpdateInsnBackward(MachineBasicBlock::iterator I, unsigned Limit);
Tim Northover3b0846e2014-05-24 12:50:23 +0000150
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000151 // Find an instruction that updates the base register of the ld/st
152 // instruction.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000153 bool isMatchingUpdateInsn(MachineInstr &MemMI, MachineInstr &MI,
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000154 unsigned BaseReg, int Offset);
155
Chad Rosier2dfd3542015-09-23 13:51:44 +0000156 // Merge a pre- or post-index base register update into a ld/st instruction.
Tim Northover3b0846e2014-05-24 12:50:23 +0000157 MachineBasicBlock::iterator
Chad Rosier2dfd3542015-09-23 13:51:44 +0000158 mergeUpdateInsn(MachineBasicBlock::iterator I,
159 MachineBasicBlock::iterator Update, bool IsPreIdx);
Tim Northover3b0846e2014-05-24 12:50:23 +0000160
Chad Rosierd6daac42016-11-07 15:27:22 +0000161 // Find and merge zero store instructions.
162 bool tryToMergeZeroStInst(MachineBasicBlock::iterator &MBBI);
Jun Bum Limc9879ec2015-10-27 19:16:03 +0000163
Chad Rosier24c46ad2016-02-09 18:10:20 +0000164 // Find and pair ldr/str instructions.
165 bool tryToPairLdStInst(MachineBasicBlock::iterator &MBBI);
166
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000167 // Find and promote load instructions which read directly from store.
168 bool tryToPromoteLoadFromStore(MachineBasicBlock::iterator &MBBI);
169
Evandro Menezes5ba804b2017-11-15 21:06:22 +0000170 // Find and merge a base register updates before or after a ld/st instruction.
171 bool tryToMergeLdStUpdate(MachineBasicBlock::iterator &MBBI);
172
Chad Rosierd6daac42016-11-07 15:27:22 +0000173 bool optimizeBlock(MachineBasicBlock &MBB, bool EnableNarrowZeroStOpt);
Tim Northover3b0846e2014-05-24 12:50:23 +0000174
175 bool runOnMachineFunction(MachineFunction &Fn) override;
176
Derek Schuff1dbf7a52016-04-04 17:09:25 +0000177 MachineFunctionProperties getRequiredProperties() const override {
178 return MachineFunctionProperties().set(
Matthias Braun1eb47362016-08-25 01:27:13 +0000179 MachineFunctionProperties::Property::NoVRegs);
Derek Schuff1dbf7a52016-04-04 17:09:25 +0000180 }
181
Mehdi Amini117296c2016-10-01 02:56:57 +0000182 StringRef getPassName() const override { return AARCH64_LOAD_STORE_OPT_NAME; }
Tim Northover3b0846e2014-05-24 12:50:23 +0000183};
Eugene Zelenko11f69072017-01-25 00:29:26 +0000184
Tim Northover3b0846e2014-05-24 12:50:23 +0000185char AArch64LoadStoreOpt::ID = 0;
Eugene Zelenko11f69072017-01-25 00:29:26 +0000186
187} // end anonymous namespace
Tim Northover3b0846e2014-05-24 12:50:23 +0000188
Chad Rosier96530b32015-08-05 13:44:51 +0000189INITIALIZE_PASS(AArch64LoadStoreOpt, "aarch64-ldst-opt",
190 AARCH64_LOAD_STORE_OPT_NAME, false, false)
191
Jun Bum Lim80ec0d32015-11-20 21:14:07 +0000192static bool isNarrowStore(unsigned Opc) {
193 switch (Opc) {
194 default:
195 return false;
196 case AArch64::STRBBui:
197 case AArch64::STURBBi:
198 case AArch64::STRHHui:
199 case AArch64::STURHHi:
200 return true;
201 }
202}
203
Chad Rosier32d4d372015-09-29 16:07:32 +0000204// Scaling factor for unscaled load or store.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000205static int getMemScale(MachineInstr &MI) {
206 switch (MI.getOpcode()) {
Tim Northover3b0846e2014-05-24 12:50:23 +0000207 default:
Chad Rosierdabe2532015-09-29 18:26:15 +0000208 llvm_unreachable("Opcode has unknown scale!");
209 case AArch64::LDRBBui:
Jun Bum Lim4c35cca2015-11-19 17:21:41 +0000210 case AArch64::LDURBBi:
211 case AArch64::LDRSBWui:
212 case AArch64::LDURSBWi:
Chad Rosierdabe2532015-09-29 18:26:15 +0000213 case AArch64::STRBBui:
Jun Bum Lim80ec0d32015-11-20 21:14:07 +0000214 case AArch64::STURBBi:
Chad Rosierdabe2532015-09-29 18:26:15 +0000215 return 1;
216 case AArch64::LDRHHui:
Jun Bum Limc9879ec2015-10-27 19:16:03 +0000217 case AArch64::LDURHHi:
Jun Bum Lim4c35cca2015-11-19 17:21:41 +0000218 case AArch64::LDRSHWui:
219 case AArch64::LDURSHWi:
Chad Rosierdabe2532015-09-29 18:26:15 +0000220 case AArch64::STRHHui:
Jun Bum Lim80ec0d32015-11-20 21:14:07 +0000221 case AArch64::STURHHi:
Chad Rosierdabe2532015-09-29 18:26:15 +0000222 return 2;
Chad Rosiera4d32172015-09-29 14:57:10 +0000223 case AArch64::LDRSui:
224 case AArch64::LDURSi:
225 case AArch64::LDRSWui:
226 case AArch64::LDURSWi:
227 case AArch64::LDRWui:
228 case AArch64::LDURWi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000229 case AArch64::STRSui:
230 case AArch64::STURSi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000231 case AArch64::STRWui:
232 case AArch64::STURWi:
Chad Rosier32d4d372015-09-29 16:07:32 +0000233 case AArch64::LDPSi:
Chad Rosier43150122015-09-29 20:39:55 +0000234 case AArch64::LDPSWi:
Chad Rosier32d4d372015-09-29 16:07:32 +0000235 case AArch64::LDPWi:
236 case AArch64::STPSi:
237 case AArch64::STPWi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000238 return 4;
Chad Rosiera4d32172015-09-29 14:57:10 +0000239 case AArch64::LDRDui:
240 case AArch64::LDURDi:
241 case AArch64::LDRXui:
242 case AArch64::LDURXi:
243 case AArch64::STRDui:
244 case AArch64::STURDi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000245 case AArch64::STRXui:
246 case AArch64::STURXi:
Chad Rosier32d4d372015-09-29 16:07:32 +0000247 case AArch64::LDPDi:
248 case AArch64::LDPXi:
249 case AArch64::STPDi:
250 case AArch64::STPXi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000251 return 8;
Tim Northover3b0846e2014-05-24 12:50:23 +0000252 case AArch64::LDRQui:
253 case AArch64::LDURQi:
Chad Rosiera4d32172015-09-29 14:57:10 +0000254 case AArch64::STRQui:
255 case AArch64::STURQi:
Chad Rosier32d4d372015-09-29 16:07:32 +0000256 case AArch64::LDPQi:
257 case AArch64::STPQi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000258 return 16;
Tim Northover3b0846e2014-05-24 12:50:23 +0000259 }
260}
261
Quentin Colombet66b61632015-03-06 22:42:10 +0000262static unsigned getMatchingNonSExtOpcode(unsigned Opc,
263 bool *IsValidLdStrOpc = nullptr) {
264 if (IsValidLdStrOpc)
265 *IsValidLdStrOpc = true;
266 switch (Opc) {
267 default:
268 if (IsValidLdStrOpc)
269 *IsValidLdStrOpc = false;
Eugene Zelenko11f69072017-01-25 00:29:26 +0000270 return std::numeric_limits<unsigned>::max();
Quentin Colombet66b61632015-03-06 22:42:10 +0000271 case AArch64::STRDui:
272 case AArch64::STURDi:
273 case AArch64::STRQui:
274 case AArch64::STURQi:
Jun Bum Lim80ec0d32015-11-20 21:14:07 +0000275 case AArch64::STRBBui:
276 case AArch64::STURBBi:
277 case AArch64::STRHHui:
278 case AArch64::STURHHi:
Quentin Colombet66b61632015-03-06 22:42:10 +0000279 case AArch64::STRWui:
280 case AArch64::STURWi:
281 case AArch64::STRXui:
282 case AArch64::STURXi:
283 case AArch64::LDRDui:
284 case AArch64::LDURDi:
285 case AArch64::LDRQui:
286 case AArch64::LDURQi:
287 case AArch64::LDRWui:
288 case AArch64::LDURWi:
289 case AArch64::LDRXui:
290 case AArch64::LDURXi:
291 case AArch64::STRSui:
292 case AArch64::STURSi:
293 case AArch64::LDRSui:
294 case AArch64::LDURSi:
295 return Opc;
296 case AArch64::LDRSWui:
297 return AArch64::LDRWui;
298 case AArch64::LDURSWi:
299 return AArch64::LDURWi;
300 }
301}
302
Jun Bum Lim1de2d442016-02-05 20:02:03 +0000303static unsigned getMatchingWideOpcode(unsigned Opc) {
304 switch (Opc) {
305 default:
306 llvm_unreachable("Opcode has no wide equivalent!");
307 case AArch64::STRBBui:
308 return AArch64::STRHHui;
309 case AArch64::STRHHui:
310 return AArch64::STRWui;
311 case AArch64::STURBBi:
312 return AArch64::STURHHi;
313 case AArch64::STURHHi:
314 return AArch64::STURWi;
Jun Bum Lim397eb7b2016-02-12 15:25:39 +0000315 case AArch64::STURWi:
316 return AArch64::STURXi;
317 case AArch64::STRWui:
318 return AArch64::STRXui;
Jun Bum Lim1de2d442016-02-05 20:02:03 +0000319 }
320}
321
Tim Northover3b0846e2014-05-24 12:50:23 +0000322static unsigned getMatchingPairOpcode(unsigned Opc) {
323 switch (Opc) {
324 default:
325 llvm_unreachable("Opcode has no pairwise equivalent!");
326 case AArch64::STRSui:
327 case AArch64::STURSi:
328 return AArch64::STPSi;
329 case AArch64::STRDui:
330 case AArch64::STURDi:
331 return AArch64::STPDi;
332 case AArch64::STRQui:
333 case AArch64::STURQi:
334 return AArch64::STPQi;
335 case AArch64::STRWui:
336 case AArch64::STURWi:
337 return AArch64::STPWi;
338 case AArch64::STRXui:
339 case AArch64::STURXi:
340 return AArch64::STPXi;
341 case AArch64::LDRSui:
342 case AArch64::LDURSi:
343 return AArch64::LDPSi;
344 case AArch64::LDRDui:
345 case AArch64::LDURDi:
346 return AArch64::LDPDi;
347 case AArch64::LDRQui:
348 case AArch64::LDURQi:
349 return AArch64::LDPQi;
350 case AArch64::LDRWui:
351 case AArch64::LDURWi:
352 return AArch64::LDPWi;
353 case AArch64::LDRXui:
354 case AArch64::LDURXi:
355 return AArch64::LDPXi;
Quentin Colombet29f55332015-01-24 01:25:54 +0000356 case AArch64::LDRSWui:
357 case AArch64::LDURSWi:
358 return AArch64::LDPSWi;
Tim Northover3b0846e2014-05-24 12:50:23 +0000359 }
360}
361
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000362static unsigned isMatchingStore(MachineInstr &LoadInst,
363 MachineInstr &StoreInst) {
364 unsigned LdOpc = LoadInst.getOpcode();
365 unsigned StOpc = StoreInst.getOpcode();
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000366 switch (LdOpc) {
367 default:
368 llvm_unreachable("Unsupported load instruction!");
369 case AArch64::LDRBBui:
370 return StOpc == AArch64::STRBBui || StOpc == AArch64::STRHHui ||
371 StOpc == AArch64::STRWui || StOpc == AArch64::STRXui;
372 case AArch64::LDURBBi:
373 return StOpc == AArch64::STURBBi || StOpc == AArch64::STURHHi ||
374 StOpc == AArch64::STURWi || StOpc == AArch64::STURXi;
375 case AArch64::LDRHHui:
376 return StOpc == AArch64::STRHHui || StOpc == AArch64::STRWui ||
377 StOpc == AArch64::STRXui;
378 case AArch64::LDURHHi:
379 return StOpc == AArch64::STURHHi || StOpc == AArch64::STURWi ||
380 StOpc == AArch64::STURXi;
381 case AArch64::LDRWui:
382 return StOpc == AArch64::STRWui || StOpc == AArch64::STRXui;
383 case AArch64::LDURWi:
384 return StOpc == AArch64::STURWi || StOpc == AArch64::STURXi;
385 case AArch64::LDRXui:
386 return StOpc == AArch64::STRXui;
387 case AArch64::LDURXi:
388 return StOpc == AArch64::STURXi;
389 }
390}
391
Tim Northover3b0846e2014-05-24 12:50:23 +0000392static unsigned getPreIndexedOpcode(unsigned Opc) {
Chad Rosier14fc82a2017-08-04 16:44:06 +0000393 // FIXME: We don't currently support creating pre-indexed loads/stores when
394 // the load or store is the unscaled version. If we decide to perform such an
395 // optimization in the future the cases for the unscaled loads/stores will
396 // need to be added here.
Tim Northover3b0846e2014-05-24 12:50:23 +0000397 switch (Opc) {
398 default:
399 llvm_unreachable("Opcode has no pre-indexed equivalent!");
Tilmann Scheller5d8d72c2014-06-04 12:40:35 +0000400 case AArch64::STRSui:
401 return AArch64::STRSpre;
402 case AArch64::STRDui:
403 return AArch64::STRDpre;
404 case AArch64::STRQui:
405 return AArch64::STRQpre;
Chad Rosierdabe2532015-09-29 18:26:15 +0000406 case AArch64::STRBBui:
407 return AArch64::STRBBpre;
408 case AArch64::STRHHui:
409 return AArch64::STRHHpre;
Tilmann Scheller5d8d72c2014-06-04 12:40:35 +0000410 case AArch64::STRWui:
411 return AArch64::STRWpre;
412 case AArch64::STRXui:
413 return AArch64::STRXpre;
414 case AArch64::LDRSui:
415 return AArch64::LDRSpre;
416 case AArch64::LDRDui:
417 return AArch64::LDRDpre;
418 case AArch64::LDRQui:
419 return AArch64::LDRQpre;
Chad Rosierdabe2532015-09-29 18:26:15 +0000420 case AArch64::LDRBBui:
421 return AArch64::LDRBBpre;
422 case AArch64::LDRHHui:
423 return AArch64::LDRHHpre;
Tilmann Scheller5d8d72c2014-06-04 12:40:35 +0000424 case AArch64::LDRWui:
425 return AArch64::LDRWpre;
426 case AArch64::LDRXui:
427 return AArch64::LDRXpre;
Quentin Colombet29f55332015-01-24 01:25:54 +0000428 case AArch64::LDRSWui:
429 return AArch64::LDRSWpre;
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000430 case AArch64::LDPSi:
431 return AArch64::LDPSpre;
Chad Rosier43150122015-09-29 20:39:55 +0000432 case AArch64::LDPSWi:
433 return AArch64::LDPSWpre;
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000434 case AArch64::LDPDi:
435 return AArch64::LDPDpre;
436 case AArch64::LDPQi:
437 return AArch64::LDPQpre;
438 case AArch64::LDPWi:
439 return AArch64::LDPWpre;
440 case AArch64::LDPXi:
441 return AArch64::LDPXpre;
442 case AArch64::STPSi:
443 return AArch64::STPSpre;
444 case AArch64::STPDi:
445 return AArch64::STPDpre;
446 case AArch64::STPQi:
447 return AArch64::STPQpre;
448 case AArch64::STPWi:
449 return AArch64::STPWpre;
450 case AArch64::STPXi:
451 return AArch64::STPXpre;
Tim Northover3b0846e2014-05-24 12:50:23 +0000452 }
453}
454
455static unsigned getPostIndexedOpcode(unsigned Opc) {
456 switch (Opc) {
457 default:
458 llvm_unreachable("Opcode has no post-indexed wise equivalent!");
459 case AArch64::STRSui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000460 case AArch64::STURSi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000461 return AArch64::STRSpost;
462 case AArch64::STRDui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000463 case AArch64::STURDi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000464 return AArch64::STRDpost;
465 case AArch64::STRQui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000466 case AArch64::STURQi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000467 return AArch64::STRQpost;
Chad Rosierdabe2532015-09-29 18:26:15 +0000468 case AArch64::STRBBui:
469 return AArch64::STRBBpost;
470 case AArch64::STRHHui:
471 return AArch64::STRHHpost;
Tim Northover3b0846e2014-05-24 12:50:23 +0000472 case AArch64::STRWui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000473 case AArch64::STURWi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000474 return AArch64::STRWpost;
475 case AArch64::STRXui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000476 case AArch64::STURXi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000477 return AArch64::STRXpost;
478 case AArch64::LDRSui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000479 case AArch64::LDURSi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000480 return AArch64::LDRSpost;
481 case AArch64::LDRDui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000482 case AArch64::LDURDi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000483 return AArch64::LDRDpost;
484 case AArch64::LDRQui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000485 case AArch64::LDURQi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000486 return AArch64::LDRQpost;
Chad Rosierdabe2532015-09-29 18:26:15 +0000487 case AArch64::LDRBBui:
488 return AArch64::LDRBBpost;
489 case AArch64::LDRHHui:
490 return AArch64::LDRHHpost;
Tim Northover3b0846e2014-05-24 12:50:23 +0000491 case AArch64::LDRWui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000492 case AArch64::LDURWi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000493 return AArch64::LDRWpost;
494 case AArch64::LDRXui:
Chad Rosier14fc82a2017-08-04 16:44:06 +0000495 case AArch64::LDURXi:
Tim Northover3b0846e2014-05-24 12:50:23 +0000496 return AArch64::LDRXpost;
Quentin Colombet29f55332015-01-24 01:25:54 +0000497 case AArch64::LDRSWui:
498 return AArch64::LDRSWpost;
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000499 case AArch64::LDPSi:
500 return AArch64::LDPSpost;
Chad Rosier43150122015-09-29 20:39:55 +0000501 case AArch64::LDPSWi:
502 return AArch64::LDPSWpost;
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000503 case AArch64::LDPDi:
504 return AArch64::LDPDpost;
505 case AArch64::LDPQi:
506 return AArch64::LDPQpost;
507 case AArch64::LDPWi:
508 return AArch64::LDPWpost;
509 case AArch64::LDPXi:
510 return AArch64::LDPXpost;
511 case AArch64::STPSi:
512 return AArch64::STPSpost;
513 case AArch64::STPDi:
514 return AArch64::STPDpost;
515 case AArch64::STPQi:
516 return AArch64::STPQpost;
517 case AArch64::STPWi:
518 return AArch64::STPWpost;
519 case AArch64::STPXi:
520 return AArch64::STPXpost;
Tim Northover3b0846e2014-05-24 12:50:23 +0000521 }
522}
523
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000524static bool isPairedLdSt(const MachineInstr &MI) {
525 switch (MI.getOpcode()) {
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000526 default:
527 return false;
528 case AArch64::LDPSi:
Chad Rosier43150122015-09-29 20:39:55 +0000529 case AArch64::LDPSWi:
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000530 case AArch64::LDPDi:
531 case AArch64::LDPQi:
532 case AArch64::LDPWi:
533 case AArch64::LDPXi:
534 case AArch64::STPSi:
535 case AArch64::STPDi:
536 case AArch64::STPQi:
537 case AArch64::STPWi:
538 case AArch64::STPXi:
539 return true;
540 }
541}
542
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000543static const MachineOperand &getLdStRegOp(const MachineInstr &MI,
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000544 unsigned PairedRegOp = 0) {
545 assert(PairedRegOp < 2 && "Unexpected register operand idx.");
546 unsigned Idx = isPairedLdSt(MI) ? PairedRegOp : 0;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000547 return MI.getOperand(Idx);
Chad Rosierf77e9092015-08-06 15:50:12 +0000548}
549
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000550static const MachineOperand &getLdStBaseOp(const MachineInstr &MI) {
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000551 unsigned Idx = isPairedLdSt(MI) ? 2 : 1;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000552 return MI.getOperand(Idx);
Chad Rosierf77e9092015-08-06 15:50:12 +0000553}
554
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000555static const MachineOperand &getLdStOffsetOp(const MachineInstr &MI) {
Chad Rosier1bbd7fb2015-09-25 17:48:17 +0000556 unsigned Idx = isPairedLdSt(MI) ? 3 : 2;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000557 return MI.getOperand(Idx);
Chad Rosierf77e9092015-08-06 15:50:12 +0000558}
559
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000560static bool isLdOffsetInRangeOfSt(MachineInstr &LoadInst,
561 MachineInstr &StoreInst,
Chad Rosiere4e15ba2016-03-09 17:29:48 +0000562 const AArch64InstrInfo *TII) {
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000563 assert(isMatchingStore(LoadInst, StoreInst) && "Expect only matched ld/st.");
564 int LoadSize = getMemScale(LoadInst);
565 int StoreSize = getMemScale(StoreInst);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000566 int UnscaledStOffset = TII->isUnscaledLdSt(StoreInst)
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000567 ? getLdStOffsetOp(StoreInst).getImm()
568 : getLdStOffsetOp(StoreInst).getImm() * StoreSize;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000569 int UnscaledLdOffset = TII->isUnscaledLdSt(LoadInst)
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000570 ? getLdStOffsetOp(LoadInst).getImm()
571 : getLdStOffsetOp(LoadInst).getImm() * LoadSize;
572 return (UnscaledStOffset <= UnscaledLdOffset) &&
573 (UnscaledLdOffset + LoadSize <= (UnscaledStOffset + StoreSize));
574}
575
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000576static bool isPromotableZeroStoreInst(MachineInstr &MI) {
Chad Rosierd6daac42016-11-07 15:27:22 +0000577 unsigned Opc = MI.getOpcode();
578 return (Opc == AArch64::STRWui || Opc == AArch64::STURWi ||
579 isNarrowStore(Opc)) &&
Jun Bum Lim397eb7b2016-02-12 15:25:39 +0000580 getLdStRegOp(MI).getReg() == AArch64::WZR;
581}
582
Evandro Menezes5ba804b2017-11-15 21:06:22 +0000583static bool isPromotableLoadFromStore(MachineInstr &MI) {
584 switch (MI.getOpcode()) {
585 default:
586 return false;
587 // Scaled instructions.
588 case AArch64::LDRBBui:
589 case AArch64::LDRHHui:
590 case AArch64::LDRWui:
591 case AArch64::LDRXui:
592 // Unscaled instructions.
593 case AArch64::LDURBBi:
594 case AArch64::LDURHHi:
595 case AArch64::LDURWi:
596 case AArch64::LDURXi:
597 return true;
598 }
599}
600
601static bool isMergeableLdStUpdate(MachineInstr &MI) {
602 unsigned Opc = MI.getOpcode();
603 switch (Opc) {
604 default:
605 return false;
606 // Scaled instructions.
607 case AArch64::STRSui:
608 case AArch64::STRDui:
609 case AArch64::STRQui:
610 case AArch64::STRXui:
611 case AArch64::STRWui:
612 case AArch64::STRHHui:
613 case AArch64::STRBBui:
614 case AArch64::LDRSui:
615 case AArch64::LDRDui:
616 case AArch64::LDRQui:
617 case AArch64::LDRXui:
618 case AArch64::LDRWui:
619 case AArch64::LDRHHui:
620 case AArch64::LDRBBui:
621 // Unscaled instructions.
622 case AArch64::STURSi:
623 case AArch64::STURDi:
624 case AArch64::STURQi:
625 case AArch64::STURWi:
626 case AArch64::STURXi:
627 case AArch64::LDURSi:
628 case AArch64::LDURDi:
629 case AArch64::LDURQi:
630 case AArch64::LDURWi:
631 case AArch64::LDURXi:
632 // Paired instructions.
633 case AArch64::LDPSi:
634 case AArch64::LDPSWi:
635 case AArch64::LDPDi:
636 case AArch64::LDPQi:
637 case AArch64::LDPWi:
638 case AArch64::LDPXi:
639 case AArch64::STPSi:
640 case AArch64::STPDi:
641 case AArch64::STPQi:
642 case AArch64::STPWi:
643 case AArch64::STPXi:
644 // Make sure this is a reg+imm (as opposed to an address reloc).
645 if (!getLdStOffsetOp(MI).isImm())
646 return false;
647
648 return true;
649 }
650}
651
Tim Northover3b0846e2014-05-24 12:50:23 +0000652MachineBasicBlock::iterator
Chad Rosierd6daac42016-11-07 15:27:22 +0000653AArch64LoadStoreOpt::mergeNarrowZeroStores(MachineBasicBlock::iterator I,
654 MachineBasicBlock::iterator MergeMI,
655 const LdStPairFlags &Flags) {
656 assert(isPromotableZeroStoreInst(*I) && isPromotableZeroStoreInst(*MergeMI) &&
657 "Expected promotable zero stores.");
658
Tim Northover3b0846e2014-05-24 12:50:23 +0000659 MachineBasicBlock::iterator NextI = I;
660 ++NextI;
661 // If NextI is the second of the two instructions to be merged, we need
662 // to skip one further. Either way we merge will invalidate the iterator,
663 // and we don't need to scan the new instruction, as it's a pairwise
664 // instruction, which we're not considering for further action anyway.
Chad Rosierd7363db2016-02-09 19:09:22 +0000665 if (NextI == MergeMI)
Tim Northover3b0846e2014-05-24 12:50:23 +0000666 ++NextI;
667
Chad Rosierb5933d72016-02-09 19:02:12 +0000668 unsigned Opc = I->getOpcode();
Chad Rosiere4e15ba2016-03-09 17:29:48 +0000669 bool IsScaled = !TII->isUnscaledLdSt(Opc);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000670 int OffsetStride = IsScaled ? 1 : getMemScale(*I);
Tim Northover3b0846e2014-05-24 12:50:23 +0000671
Chad Rosier96a18a92015-07-21 17:42:04 +0000672 bool MergeForward = Flags.getMergeForward();
Tim Northover3b0846e2014-05-24 12:50:23 +0000673 // Insert our new paired instruction after whichever of the paired
Tilmann Scheller4aad3bd2014-06-04 12:36:28 +0000674 // instructions MergeForward indicates.
Chad Rosierd7363db2016-02-09 19:09:22 +0000675 MachineBasicBlock::iterator InsertionPoint = MergeForward ? MergeMI : I;
Tilmann Scheller4aad3bd2014-06-04 12:36:28 +0000676 // Also based on MergeForward is from where we copy the base register operand
Tim Northover3b0846e2014-05-24 12:50:23 +0000677 // so we get the flags compatible with the input code.
Chad Rosierf77e9092015-08-06 15:50:12 +0000678 const MachineOperand &BaseRegOp =
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000679 MergeForward ? getLdStBaseOp(*MergeMI) : getLdStBaseOp(*I);
Tim Northover3b0846e2014-05-24 12:50:23 +0000680
681 // Which register is Rt and which is Rt2 depends on the offset order.
Davide Italiano5df60662016-11-07 19:11:25 +0000682 MachineInstr *RtMI;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000683 if (getLdStOffsetOp(*I).getImm() ==
Davide Italiano5df60662016-11-07 19:11:25 +0000684 getLdStOffsetOp(*MergeMI).getImm() + OffsetStride)
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000685 RtMI = &*MergeMI;
Davide Italiano5df60662016-11-07 19:11:25 +0000686 else
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000687 RtMI = &*I;
Jun Bum Limc9879ec2015-10-27 19:16:03 +0000688
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000689 int OffsetImm = getLdStOffsetOp(*RtMI).getImm();
Chad Rosier11eedc92016-02-09 19:17:18 +0000690 // Change the scaled offset from small to large type.
691 if (IsScaled) {
692 assert(((OffsetImm & 1) == 0) && "Unexpected offset to merge");
693 OffsetImm /= 2;
694 }
695
Chad Rosierd6daac42016-11-07 15:27:22 +0000696 // Construct the new instruction.
Chad Rosierc46ef882016-02-09 19:33:42 +0000697 DebugLoc DL = I->getDebugLoc();
698 MachineBasicBlock *MBB = I->getParent();
Jun Bum Lim80ec0d32015-11-20 21:14:07 +0000699 MachineInstrBuilder MIB;
Chad Rosierc46ef882016-02-09 19:33:42 +0000700 MIB = BuildMI(*MBB, InsertionPoint, DL, TII->get(getMatchingWideOpcode(Opc)))
Jun Bum Lim397eb7b2016-02-12 15:25:39 +0000701 .addReg(isNarrowStore(Opc) ? AArch64::WZR : AArch64::XZR)
Diana Picus116bbab2017-01-13 09:58:52 +0000702 .add(BaseRegOp)
Chad Rosierb5933d72016-02-09 19:02:12 +0000703 .addImm(OffsetImm)
Chandler Carruthc73c0302018-08-16 21:30:05 +0000704 .cloneMergedMemRefs({&*I, &*MergeMI})
Francis Visoiu Mistrih084e7d82018-03-14 17:10:58 +0000705 .setMIFlags(I->mergeFlagsWith(*MergeMI));
Tim Northover3b0846e2014-05-24 12:50:23 +0000706 (void)MIB;
707
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000708 LLVM_DEBUG(dbgs() << "Creating wider store. Replacing instructions:\n ");
709 LLVM_DEBUG(I->print(dbgs()));
710 LLVM_DEBUG(dbgs() << " ");
711 LLVM_DEBUG(MergeMI->print(dbgs()));
712 LLVM_DEBUG(dbgs() << " with instruction:\n ");
713 LLVM_DEBUG(((MachineInstr *)MIB)->print(dbgs()));
714 LLVM_DEBUG(dbgs() << "\n");
Chad Rosierb5933d72016-02-09 19:02:12 +0000715
716 // Erase the old instructions.
717 I->eraseFromParent();
Chad Rosierd7363db2016-02-09 19:09:22 +0000718 MergeMI->eraseFromParent();
Chad Rosierb5933d72016-02-09 19:02:12 +0000719 return NextI;
720}
721
722MachineBasicBlock::iterator
723AArch64LoadStoreOpt::mergePairedInsns(MachineBasicBlock::iterator I,
724 MachineBasicBlock::iterator Paired,
725 const LdStPairFlags &Flags) {
726 MachineBasicBlock::iterator NextI = I;
727 ++NextI;
728 // If NextI is the second of the two instructions to be merged, we need
729 // to skip one further. Either way we merge will invalidate the iterator,
730 // and we don't need to scan the new instruction, as it's a pairwise
731 // instruction, which we're not considering for further action anyway.
732 if (NextI == Paired)
733 ++NextI;
734
735 int SExtIdx = Flags.getSExtIdx();
736 unsigned Opc =
737 SExtIdx == -1 ? I->getOpcode() : getMatchingNonSExtOpcode(I->getOpcode());
Chad Rosiere4e15ba2016-03-09 17:29:48 +0000738 bool IsUnscaled = TII->isUnscaledLdSt(Opc);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000739 int OffsetStride = IsUnscaled ? getMemScale(*I) : 1;
Chad Rosierb5933d72016-02-09 19:02:12 +0000740
741 bool MergeForward = Flags.getMergeForward();
742 // Insert our new paired instruction after whichever of the paired
743 // instructions MergeForward indicates.
744 MachineBasicBlock::iterator InsertionPoint = MergeForward ? Paired : I;
745 // Also based on MergeForward is from where we copy the base register operand
746 // so we get the flags compatible with the input code.
747 const MachineOperand &BaseRegOp =
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000748 MergeForward ? getLdStBaseOp(*Paired) : getLdStBaseOp(*I);
Chad Rosierb5933d72016-02-09 19:02:12 +0000749
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000750 int Offset = getLdStOffsetOp(*I).getImm();
751 int PairedOffset = getLdStOffsetOp(*Paired).getImm();
Chad Rosiere4e15ba2016-03-09 17:29:48 +0000752 bool PairedIsUnscaled = TII->isUnscaledLdSt(Paired->getOpcode());
Chad Rosier00f9d232016-02-11 14:25:08 +0000753 if (IsUnscaled != PairedIsUnscaled) {
754 // We're trying to pair instructions that differ in how they are scaled. If
755 // I is scaled then scale the offset of Paired accordingly. Otherwise, do
756 // the opposite (i.e., make Paired's offset unscaled).
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000757 int MemSize = getMemScale(*Paired);
Chad Rosier00f9d232016-02-11 14:25:08 +0000758 if (PairedIsUnscaled) {
759 // If the unscaled offset isn't a multiple of the MemSize, we can't
760 // pair the operations together.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000761 assert(!(PairedOffset % getMemScale(*Paired)) &&
Chad Rosier00f9d232016-02-11 14:25:08 +0000762 "Offset should be a multiple of the stride!");
763 PairedOffset /= MemSize;
764 } else {
765 PairedOffset *= MemSize;
766 }
767 }
768
Chad Rosierb5933d72016-02-09 19:02:12 +0000769 // Which register is Rt and which is Rt2 depends on the offset order.
770 MachineInstr *RtMI, *Rt2MI;
Chad Rosier00f9d232016-02-11 14:25:08 +0000771 if (Offset == PairedOffset + OffsetStride) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000772 RtMI = &*Paired;
773 Rt2MI = &*I;
Chad Rosierb5933d72016-02-09 19:02:12 +0000774 // Here we swapped the assumption made for SExtIdx.
775 // I.e., we turn ldp I, Paired into ldp Paired, I.
776 // Update the index accordingly.
777 if (SExtIdx != -1)
778 SExtIdx = (SExtIdx + 1) % 2;
779 } else {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000780 RtMI = &*I;
781 Rt2MI = &*Paired;
Chad Rosierb5933d72016-02-09 19:02:12 +0000782 }
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000783 int OffsetImm = getLdStOffsetOp(*RtMI).getImm();
Chad Rosier00f9d232016-02-11 14:25:08 +0000784 // Scale the immediate offset, if necessary.
Chad Rosiere4e15ba2016-03-09 17:29:48 +0000785 if (TII->isUnscaledLdSt(RtMI->getOpcode())) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000786 assert(!(OffsetImm % getMemScale(*RtMI)) &&
Chad Rosier00f9d232016-02-11 14:25:08 +0000787 "Unscaled offset cannot be scaled.");
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000788 OffsetImm /= getMemScale(*RtMI);
Chad Rosier87e33412016-02-09 20:18:07 +0000789 }
Chad Rosierb5933d72016-02-09 19:02:12 +0000790
791 // Construct the new instruction.
792 MachineInstrBuilder MIB;
Chad Rosierc46ef882016-02-09 19:33:42 +0000793 DebugLoc DL = I->getDebugLoc();
794 MachineBasicBlock *MBB = I->getParent();
Matthias Braun2e8c11e2017-01-20 18:04:27 +0000795 MachineOperand RegOp0 = getLdStRegOp(*RtMI);
796 MachineOperand RegOp1 = getLdStRegOp(*Rt2MI);
797 // Kill flags may become invalid when moving stores for pairing.
798 if (RegOp0.isUse()) {
799 if (!MergeForward) {
800 // Clear kill flags on store if moving upwards. Example:
801 // STRWui %w0, ...
802 // USE %w1
803 // STRWui kill %w1 ; need to clear kill flag when moving STRWui upwards
804 RegOp0.setIsKill(false);
805 RegOp1.setIsKill(false);
806 } else {
807 // Clear kill flags of the first stores register. Example:
808 // STRWui %w1, ...
809 // USE kill %w1 ; need to clear kill flag when moving STRWui downwards
810 // STRW %w0
811 unsigned Reg = getLdStRegOp(*I).getReg();
812 for (MachineInstr &MI : make_range(std::next(I), Paired))
813 MI.clearRegisterKills(Reg, TRI);
814 }
815 }
Chad Rosierc46ef882016-02-09 19:33:42 +0000816 MIB = BuildMI(*MBB, InsertionPoint, DL, TII->get(getMatchingPairOpcode(Opc)))
Matthias Braun2e8c11e2017-01-20 18:04:27 +0000817 .add(RegOp0)
818 .add(RegOp1)
Diana Picus116bbab2017-01-13 09:58:52 +0000819 .add(BaseRegOp)
Chad Rosiere40b9512016-03-08 17:16:38 +0000820 .addImm(OffsetImm)
Chandler Carruthc73c0302018-08-16 21:30:05 +0000821 .cloneMergedMemRefs({&*I, &*Paired})
Francis Visoiu Mistrih084e7d82018-03-14 17:10:58 +0000822 .setMIFlags(I->mergeFlagsWith(*Paired));
Chad Rosierb5933d72016-02-09 19:02:12 +0000823
824 (void)MIB;
Tim Northover3b0846e2014-05-24 12:50:23 +0000825
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000826 LLVM_DEBUG(
827 dbgs() << "Creating pair load/store. Replacing instructions:\n ");
828 LLVM_DEBUG(I->print(dbgs()));
829 LLVM_DEBUG(dbgs() << " ");
830 LLVM_DEBUG(Paired->print(dbgs()));
831 LLVM_DEBUG(dbgs() << " with instruction:\n ");
Quentin Colombet66b61632015-03-06 22:42:10 +0000832 if (SExtIdx != -1) {
833 // Generate the sign extension for the proper result of the ldp.
834 // I.e., with X1, that would be:
Francis Visoiu Mistriha8a83d12017-12-07 10:40:31 +0000835 // %w1 = KILL %w1, implicit-def %x1
836 // %x1 = SBFMXri killed %x1, 0, 31
Quentin Colombet66b61632015-03-06 22:42:10 +0000837 MachineOperand &DstMO = MIB->getOperand(SExtIdx);
838 // Right now, DstMO has the extended register, since it comes from an
839 // extended opcode.
840 unsigned DstRegX = DstMO.getReg();
841 // Get the W variant of that register.
842 unsigned DstRegW = TRI->getSubReg(DstRegX, AArch64::sub_32);
843 // Update the result of LDP to use the W instead of the X variant.
844 DstMO.setReg(DstRegW);
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000845 LLVM_DEBUG(((MachineInstr *)MIB)->print(dbgs()));
846 LLVM_DEBUG(dbgs() << "\n");
Quentin Colombet66b61632015-03-06 22:42:10 +0000847 // Make the machine verifier happy by providing a definition for
848 // the X register.
849 // Insert this definition right after the generated LDP, i.e., before
850 // InsertionPoint.
851 MachineInstrBuilder MIBKill =
Chad Rosierc46ef882016-02-09 19:33:42 +0000852 BuildMI(*MBB, InsertionPoint, DL, TII->get(TargetOpcode::KILL), DstRegW)
Quentin Colombet66b61632015-03-06 22:42:10 +0000853 .addReg(DstRegW)
854 .addReg(DstRegX, RegState::Define);
855 MIBKill->getOperand(2).setImplicit();
856 // Create the sign extension.
857 MachineInstrBuilder MIBSXTW =
Chad Rosierc46ef882016-02-09 19:33:42 +0000858 BuildMI(*MBB, InsertionPoint, DL, TII->get(AArch64::SBFMXri), DstRegX)
Quentin Colombet66b61632015-03-06 22:42:10 +0000859 .addReg(DstRegX)
860 .addImm(0)
861 .addImm(31);
862 (void)MIBSXTW;
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000863 LLVM_DEBUG(dbgs() << " Extend operand:\n ");
864 LLVM_DEBUG(((MachineInstr *)MIBSXTW)->print(dbgs()));
Quentin Colombet66b61632015-03-06 22:42:10 +0000865 } else {
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000866 LLVM_DEBUG(((MachineInstr *)MIB)->print(dbgs()));
Quentin Colombet66b61632015-03-06 22:42:10 +0000867 }
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000868 LLVM_DEBUG(dbgs() << "\n");
Tim Northover3b0846e2014-05-24 12:50:23 +0000869
870 // Erase the old instructions.
871 I->eraseFromParent();
872 Paired->eraseFromParent();
873
874 return NextI;
875}
876
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000877MachineBasicBlock::iterator
878AArch64LoadStoreOpt::promoteLoadFromStore(MachineBasicBlock::iterator LoadI,
879 MachineBasicBlock::iterator StoreI) {
880 MachineBasicBlock::iterator NextI = LoadI;
881 ++NextI;
882
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000883 int LoadSize = getMemScale(*LoadI);
884 int StoreSize = getMemScale(*StoreI);
885 unsigned LdRt = getLdStRegOp(*LoadI).getReg();
Florian Hahn80e48512017-06-21 08:47:23 +0000886 const MachineOperand &StMO = getLdStRegOp(*StoreI);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000887 unsigned StRt = getLdStRegOp(*StoreI).getReg();
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000888 bool IsStoreXReg = TRI->getRegClass(AArch64::GPR64RegClassID)->contains(StRt);
889
890 assert((IsStoreXReg ||
891 TRI->getRegClass(AArch64::GPR32RegClassID)->contains(StRt)) &&
892 "Unexpected RegClass");
893
894 MachineInstr *BitExtMI;
895 if (LoadSize == StoreSize && (LoadSize == 4 || LoadSize == 8)) {
896 // Remove the load, if the destination register of the loads is the same
897 // register for stored value.
898 if (StRt == LdRt && LoadSize == 8) {
Tim Northover9ac3e422017-06-26 18:49:25 +0000899 for (MachineInstr &MI : make_range(StoreI->getIterator(),
900 LoadI->getIterator())) {
901 if (MI.killsRegister(StRt, TRI)) {
902 MI.clearRegisterKills(StRt, TRI);
903 break;
904 }
905 }
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000906 LLVM_DEBUG(dbgs() << "Remove load instruction:\n ");
907 LLVM_DEBUG(LoadI->print(dbgs()));
908 LLVM_DEBUG(dbgs() << "\n");
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000909 LoadI->eraseFromParent();
910 return NextI;
911 }
912 // Replace the load with a mov if the load and store are in the same size.
913 BitExtMI =
914 BuildMI(*LoadI->getParent(), LoadI, LoadI->getDebugLoc(),
915 TII->get(IsStoreXReg ? AArch64::ORRXrs : AArch64::ORRWrs), LdRt)
916 .addReg(IsStoreXReg ? AArch64::XZR : AArch64::WZR)
Florian Hahn80e48512017-06-21 08:47:23 +0000917 .add(StMO)
Francis Visoiu Mistrih084e7d82018-03-14 17:10:58 +0000918 .addImm(AArch64_AM::getShifterImm(AArch64_AM::LSL, 0))
919 .setMIFlags(LoadI->getFlags());
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000920 } else {
921 // FIXME: Currently we disable this transformation in big-endian targets as
922 // performance and correctness are verified only in little-endian.
923 if (!Subtarget->isLittleEndian())
924 return NextI;
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +0000925 bool IsUnscaled = TII->isUnscaledLdSt(*LoadI);
926 assert(IsUnscaled == TII->isUnscaledLdSt(*StoreI) &&
Chad Rosiere4e15ba2016-03-09 17:29:48 +0000927 "Unsupported ld/st match");
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000928 assert(LoadSize <= StoreSize && "Invalid load size");
929 int UnscaledLdOffset = IsUnscaled
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000930 ? getLdStOffsetOp(*LoadI).getImm()
931 : getLdStOffsetOp(*LoadI).getImm() * LoadSize;
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000932 int UnscaledStOffset = IsUnscaled
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +0000933 ? getLdStOffsetOp(*StoreI).getImm()
934 : getLdStOffsetOp(*StoreI).getImm() * StoreSize;
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000935 int Width = LoadSize * 8;
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000936 unsigned DestReg = IsStoreXReg
937 ? TRI->getMatchingSuperReg(LdRt, AArch64::sub_32,
938 &AArch64::GPR64RegClass)
939 : LdRt;
940
941 assert((UnscaledLdOffset >= UnscaledStOffset &&
942 (UnscaledLdOffset + LoadSize) <= UnscaledStOffset + StoreSize) &&
943 "Invalid offset");
944
Simon Pilgrime461e9a2019-05-08 16:29:39 +0000945 int Immr = 8 * (UnscaledLdOffset - UnscaledStOffset);
946 int Imms = Immr + Width - 1;
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000947 if (UnscaledLdOffset == UnscaledStOffset) {
948 uint32_t AndMaskEncoded = ((IsStoreXReg ? 1 : 0) << 12) // N
949 | ((Immr) << 6) // immr
950 | ((Imms) << 0) // imms
951 ;
952
953 BitExtMI =
954 BuildMI(*LoadI->getParent(), LoadI, LoadI->getDebugLoc(),
955 TII->get(IsStoreXReg ? AArch64::ANDXri : AArch64::ANDWri),
956 DestReg)
Florian Hahn80e48512017-06-21 08:47:23 +0000957 .add(StMO)
Francis Visoiu Mistrih084e7d82018-03-14 17:10:58 +0000958 .addImm(AndMaskEncoded)
959 .setMIFlags(LoadI->getFlags());
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000960 } else {
961 BitExtMI =
962 BuildMI(*LoadI->getParent(), LoadI, LoadI->getDebugLoc(),
963 TII->get(IsStoreXReg ? AArch64::UBFMXri : AArch64::UBFMWri),
964 DestReg)
Florian Hahn80e48512017-06-21 08:47:23 +0000965 .add(StMO)
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000966 .addImm(Immr)
Francis Visoiu Mistrih084e7d82018-03-14 17:10:58 +0000967 .addImm(Imms)
968 .setMIFlags(LoadI->getFlags());
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000969 }
970 }
Matthias Braun76bb4132016-12-16 23:55:43 +0000971
Matthias Braund9a59a82017-02-17 23:15:03 +0000972 // Clear kill flags between store and load.
973 for (MachineInstr &MI : make_range(StoreI->getIterator(),
974 BitExtMI->getIterator()))
Florian Hahn8552e592017-06-21 09:51:52 +0000975 if (MI.killsRegister(StRt, TRI)) {
976 MI.clearRegisterKills(StRt, TRI);
977 break;
978 }
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000979
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000980 LLVM_DEBUG(dbgs() << "Promoting load by replacing :\n ");
981 LLVM_DEBUG(StoreI->print(dbgs()));
982 LLVM_DEBUG(dbgs() << " ");
983 LLVM_DEBUG(LoadI->print(dbgs()));
984 LLVM_DEBUG(dbgs() << " with instructions:\n ");
985 LLVM_DEBUG(StoreI->print(dbgs()));
986 LLVM_DEBUG(dbgs() << " ");
987 LLVM_DEBUG((BitExtMI)->print(dbgs()));
988 LLVM_DEBUG(dbgs() << "\n");
Jun Bum Lim6755c3b2015-12-22 16:36:16 +0000989
990 // Erase the old instructions.
991 LoadI->eraseFromParent();
992 return NextI;
993}
994
Tim Northover3b0846e2014-05-24 12:50:23 +0000995static bool inBoundsForPair(bool IsUnscaled, int Offset, int OffsetStride) {
Chad Rosier3dd0e942015-08-18 16:20:03 +0000996 // Convert the byte-offset used by unscaled into an "element" offset used
997 // by the scaled pair load/store instructions.
Chad Rosier00f9d232016-02-11 14:25:08 +0000998 if (IsUnscaled) {
999 // If the byte-offset isn't a multiple of the stride, there's no point
1000 // trying to match it.
1001 if (Offset % OffsetStride)
1002 return false;
Chad Rosier3dd0e942015-08-18 16:20:03 +00001003 Offset /= OffsetStride;
Chad Rosier00f9d232016-02-11 14:25:08 +00001004 }
Chad Rosier3dd0e942015-08-18 16:20:03 +00001005 return Offset <= 63 && Offset >= -64;
Tim Northover3b0846e2014-05-24 12:50:23 +00001006}
1007
1008// Do alignment, specialized to power of 2 and for signed ints,
1009// avoiding having to do a C-style cast from uint_64t to int when
Rui Ueyamada00f2f2016-01-14 21:06:47 +00001010// using alignTo from include/llvm/Support/MathExtras.h.
Tim Northover3b0846e2014-05-24 12:50:23 +00001011// FIXME: Move this function to include/MathExtras.h?
1012static int alignTo(int Num, int PowOf2) {
1013 return (Num + PowOf2 - 1) & ~(PowOf2 - 1);
1014}
1015
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +00001016static bool mayAlias(MachineInstr &MIa, MachineInstr &MIb,
Chad Rosiera69dcb62017-03-17 14:19:55 +00001017 AliasAnalysis *AA) {
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001018 // One of the instructions must modify memory.
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +00001019 if (!MIa.mayStore() && !MIb.mayStore())
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001020 return false;
1021
1022 // Both instructions must be memory operations.
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +00001023 if (!MIa.mayLoadOrStore() && !MIb.mayLoadOrStore())
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001024 return false;
1025
Chad Rosiera69dcb62017-03-17 14:19:55 +00001026 return MIa.mayAlias(AA, MIb, /*UseTBAA*/false);
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001027}
1028
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +00001029static bool mayAlias(MachineInstr &MIa,
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001030 SmallVectorImpl<MachineInstr *> &MemInsns,
Chad Rosiera69dcb62017-03-17 14:19:55 +00001031 AliasAnalysis *AA) {
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +00001032 for (MachineInstr *MIb : MemInsns)
Chad Rosiera69dcb62017-03-17 14:19:55 +00001033 if (mayAlias(MIa, *MIb, AA))
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001034 return true;
1035
1036 return false;
1037}
1038
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001039bool AArch64LoadStoreOpt::findMatchingStore(
1040 MachineBasicBlock::iterator I, unsigned Limit,
1041 MachineBasicBlock::iterator &StoreI) {
Jun Bum Lim633b2d82016-02-11 16:18:24 +00001042 MachineBasicBlock::iterator B = I->getParent()->begin();
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001043 MachineBasicBlock::iterator MBBI = I;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001044 MachineInstr &LoadMI = *I;
Chad Rosier5c6a66c2016-02-09 15:59:57 +00001045 unsigned BaseReg = getLdStBaseOp(LoadMI).getReg();
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001046
Jun Bum Lim633b2d82016-02-11 16:18:24 +00001047 // If the load is the first instruction in the block, there's obviously
1048 // not any matching store.
1049 if (MBBI == B)
1050 return false;
1051
Jun Bum Lim47aece12018-04-27 18:44:37 +00001052 // Track which register units have been modified and used between the first
1053 // insn and the second insn.
1054 ModifiedRegUnits.clear();
1055 UsedRegUnits.clear();
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001056
Jun Bum Lim633b2d82016-02-11 16:18:24 +00001057 unsigned Count = 0;
1058 do {
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001059 --MBBI;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001060 MachineInstr &MI = *MBBI;
Jun Bum Lim633b2d82016-02-11 16:18:24 +00001061
Geoff Berry4ff2e362016-07-21 15:20:25 +00001062 // Don't count transient instructions towards the search limit since there
1063 // may be different numbers of them if e.g. debug information is present.
1064 if (!MI.isTransient())
Jun Bum Lim633b2d82016-02-11 16:18:24 +00001065 ++Count;
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001066
1067 // If the load instruction reads directly from the address to which the
1068 // store instruction writes and the stored value is not modified, we can
1069 // promote the load. Since we do not handle stores with pre-/post-index,
1070 // it's unnecessary to check if BaseReg is modified by the store itself.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001071 if (MI.mayStore() && isMatchingStore(LoadMI, MI) &&
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001072 BaseReg == getLdStBaseOp(MI).getReg() &&
Chad Rosiere4e15ba2016-03-09 17:29:48 +00001073 isLdOffsetInRangeOfSt(LoadMI, MI, TII) &&
Jun Bum Lim47aece12018-04-27 18:44:37 +00001074 ModifiedRegUnits.available(getLdStRegOp(MI).getReg())) {
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001075 StoreI = MBBI;
1076 return true;
1077 }
1078
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001079 if (MI.isCall())
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001080 return false;
1081
Jun Bum Lim47aece12018-04-27 18:44:37 +00001082 // Update modified / uses register units.
1083 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits, UsedRegUnits, TRI);
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001084
1085 // Otherwise, if the base register is modified, we have no match, so
1086 // return early.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001087 if (!ModifiedRegUnits.available(BaseReg))
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001088 return false;
1089
1090 // If we encounter a store aliased with the load, return early.
Chad Rosiera69dcb62017-03-17 14:19:55 +00001091 if (MI.mayStore() && mayAlias(LoadMI, MI, AA))
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001092 return false;
Jun Bum Lim633b2d82016-02-11 16:18:24 +00001093 } while (MBBI != B && Count < Limit);
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001094 return false;
1095}
1096
Chad Rosierc5083c22016-06-10 20:47:14 +00001097// Returns true if FirstMI and MI are candidates for merging or pairing.
1098// Otherwise, returns false.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001099static bool areCandidatesToMergeOrPair(MachineInstr &FirstMI, MachineInstr &MI,
Chad Rosierc5083c22016-06-10 20:47:14 +00001100 LdStPairFlags &Flags,
1101 const AArch64InstrInfo *TII) {
1102 // If this is volatile or if pairing is suppressed, not a candidate.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001103 if (MI.hasOrderedMemoryRef() || TII->isLdStPairSuppressed(MI))
Chad Rosierc5083c22016-06-10 20:47:14 +00001104 return false;
1105
1106 // We should have already checked FirstMI for pair suppression and volatility.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001107 assert(!FirstMI.hasOrderedMemoryRef() &&
1108 !TII->isLdStPairSuppressed(FirstMI) &&
Chad Rosierc5083c22016-06-10 20:47:14 +00001109 "FirstMI shouldn't get here if either of these checks are true.");
1110
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001111 unsigned OpcA = FirstMI.getOpcode();
1112 unsigned OpcB = MI.getOpcode();
Chad Rosierc5083c22016-06-10 20:47:14 +00001113
Chad Rosierc3f6cb92016-02-10 19:45:48 +00001114 // Opcodes match: nothing more to check.
1115 if (OpcA == OpcB)
1116 return true;
1117
1118 // Try to match a sign-extended load/store with a zero-extended load/store.
1119 bool IsValidLdStrOpc, PairIsValidLdStrOpc;
1120 unsigned NonSExtOpc = getMatchingNonSExtOpcode(OpcA, &IsValidLdStrOpc);
1121 assert(IsValidLdStrOpc &&
1122 "Given Opc should be a Load or Store with an immediate");
1123 // OpcA will be the first instruction in the pair.
1124 if (NonSExtOpc == getMatchingNonSExtOpcode(OpcB, &PairIsValidLdStrOpc)) {
1125 Flags.setSExtIdx(NonSExtOpc == (unsigned)OpcA ? 1 : 0);
1126 return true;
1127 }
Chad Rosier00f9d232016-02-11 14:25:08 +00001128
Chad Rosierd6daac42016-11-07 15:27:22 +00001129 // If the second instruction isn't even a mergable/pairable load/store, bail
1130 // out.
Chad Rosier00f9d232016-02-11 14:25:08 +00001131 if (!PairIsValidLdStrOpc)
1132 return false;
1133
Chad Rosierd6daac42016-11-07 15:27:22 +00001134 // FIXME: We don't support merging narrow stores with mixed scaled/unscaled
1135 // offsets.
1136 if (isNarrowStore(OpcA) || isNarrowStore(OpcB))
Chad Rosier00f9d232016-02-11 14:25:08 +00001137 return false;
1138
1139 // Try to match an unscaled load/store with a scaled load/store.
Chad Rosiere4e15ba2016-03-09 17:29:48 +00001140 return TII->isUnscaledLdSt(OpcA) != TII->isUnscaledLdSt(OpcB) &&
Chad Rosier00f9d232016-02-11 14:25:08 +00001141 getMatchingPairOpcode(OpcA) == getMatchingPairOpcode(OpcB);
1142
1143 // FIXME: Can we also match a mixed sext/zext unscaled/scaled pair?
Chad Rosierc3f6cb92016-02-10 19:45:48 +00001144}
1145
Chad Rosier9f4ec2e2016-02-10 18:49:28 +00001146/// Scan the instructions looking for a load/store that can be combined with the
1147/// current instruction into a wider equivalent or a load/store pair.
Tim Northover3b0846e2014-05-24 12:50:23 +00001148MachineBasicBlock::iterator
1149AArch64LoadStoreOpt::findMatchingInsn(MachineBasicBlock::iterator I,
Jun Bum Limcf974432016-03-31 14:47:24 +00001150 LdStPairFlags &Flags, unsigned Limit,
1151 bool FindNarrowMerge) {
Tim Northover3b0846e2014-05-24 12:50:23 +00001152 MachineBasicBlock::iterator E = I->getParent()->end();
1153 MachineBasicBlock::iterator MBBI = I;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001154 MachineInstr &FirstMI = *I;
Tim Northover3b0846e2014-05-24 12:50:23 +00001155 ++MBBI;
1156
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001157 bool MayLoad = FirstMI.mayLoad();
1158 bool IsUnscaled = TII->isUnscaledLdSt(FirstMI);
Chad Rosierf77e9092015-08-06 15:50:12 +00001159 unsigned Reg = getLdStRegOp(FirstMI).getReg();
1160 unsigned BaseReg = getLdStBaseOp(FirstMI).getReg();
1161 int Offset = getLdStOffsetOp(FirstMI).getImm();
Chad Rosierf11d0402015-10-01 18:17:12 +00001162 int OffsetStride = IsUnscaled ? getMemScale(FirstMI) : 1;
Jun Bum Lim397eb7b2016-02-12 15:25:39 +00001163 bool IsPromotableZeroStore = isPromotableZeroStoreInst(FirstMI);
Tim Northover3b0846e2014-05-24 12:50:23 +00001164
Jun Bum Lim47aece12018-04-27 18:44:37 +00001165 // Track which register units have been modified and used between the first
1166 // insn (inclusive) and the second insn.
1167 ModifiedRegUnits.clear();
1168 UsedRegUnits.clear();
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001169
1170 // Remember any instructions that read/write memory between FirstMI and MI.
1171 SmallVector<MachineInstr *, 4> MemInsns;
1172
Tim Northover3b0846e2014-05-24 12:50:23 +00001173 for (unsigned Count = 0; MBBI != E && Count < Limit; ++MBBI) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001174 MachineInstr &MI = *MBBI;
Tim Northover3b0846e2014-05-24 12:50:23 +00001175
Geoff Berry4ff2e362016-07-21 15:20:25 +00001176 // Don't count transient instructions towards the search limit since there
1177 // may be different numbers of them if e.g. debug information is present.
1178 if (!MI.isTransient())
1179 ++Count;
Tim Northover3b0846e2014-05-24 12:50:23 +00001180
Chad Rosier18896c02016-02-04 16:01:40 +00001181 Flags.setSExtIdx(-1);
Chad Rosierc5083c22016-06-10 20:47:14 +00001182 if (areCandidatesToMergeOrPair(FirstMI, MI, Flags, TII) &&
Chad Rosierc3f6cb92016-02-10 19:45:48 +00001183 getLdStOffsetOp(MI).isImm()) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001184 assert(MI.mayLoadOrStore() && "Expected memory operation.");
Tim Northover3b0846e2014-05-24 12:50:23 +00001185 // If we've found another instruction with the same opcode, check to see
1186 // if the base and offset are compatible with our starting instruction.
1187 // These instructions all have scaled immediate operands, so we just
1188 // check for +1/-1. Make sure to check the new instruction offset is
1189 // actually an immediate and not a symbolic reference destined for
1190 // a relocation.
Chad Rosierf77e9092015-08-06 15:50:12 +00001191 unsigned MIBaseReg = getLdStBaseOp(MI).getReg();
1192 int MIOffset = getLdStOffsetOp(MI).getImm();
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001193 bool MIIsUnscaled = TII->isUnscaledLdSt(MI);
Chad Rosier00f9d232016-02-11 14:25:08 +00001194 if (IsUnscaled != MIIsUnscaled) {
1195 // We're trying to pair instructions that differ in how they are scaled.
1196 // If FirstMI is scaled then scale the offset of MI accordingly.
1197 // Otherwise, do the opposite (i.e., make MI's offset unscaled).
1198 int MemSize = getMemScale(MI);
1199 if (MIIsUnscaled) {
1200 // If the unscaled offset isn't a multiple of the MemSize, we can't
1201 // pair the operations together: bail and keep looking.
Eli Friedmanf184e4b2016-08-12 20:39:51 +00001202 if (MIOffset % MemSize) {
Jun Bum Lim47aece12018-04-27 18:44:37 +00001203 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits,
1204 UsedRegUnits, TRI);
Eli Friedmanf184e4b2016-08-12 20:39:51 +00001205 MemInsns.push_back(&MI);
Chad Rosier00f9d232016-02-11 14:25:08 +00001206 continue;
Eli Friedmanf184e4b2016-08-12 20:39:51 +00001207 }
Chad Rosier00f9d232016-02-11 14:25:08 +00001208 MIOffset /= MemSize;
1209 } else {
1210 MIOffset *= MemSize;
1211 }
1212 }
1213
Tim Northover3b0846e2014-05-24 12:50:23 +00001214 if (BaseReg == MIBaseReg && ((Offset == MIOffset + OffsetStride) ||
1215 (Offset + OffsetStride == MIOffset))) {
1216 int MinOffset = Offset < MIOffset ? Offset : MIOffset;
Jun Bum Limcf974432016-03-31 14:47:24 +00001217 if (FindNarrowMerge) {
Jun Bum Lim80ec0d32015-11-20 21:14:07 +00001218 // If the alignment requirements of the scaled wide load/store
Jun Bum Limcf974432016-03-31 14:47:24 +00001219 // instruction can't express the offset of the scaled narrow input,
1220 // bail and keep looking. For promotable zero stores, allow only when
1221 // the stored value is the same (i.e., WZR).
1222 if ((!IsUnscaled && alignTo(MinOffset, 2) != MinOffset) ||
1223 (IsPromotableZeroStore && Reg != getLdStRegOp(MI).getReg())) {
Jun Bum Lim47aece12018-04-27 18:44:37 +00001224 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits,
1225 UsedRegUnits, TRI);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001226 MemInsns.push_back(&MI);
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001227 continue;
1228 }
1229 } else {
Chad Rosierd1f6c842016-06-10 20:49:18 +00001230 // Pairwise instructions have a 7-bit signed offset field. Single
1231 // insns have a 12-bit unsigned offset field. If the resultant
1232 // immediate offset of merging these instructions is out of range for
1233 // a pairwise instruction, bail and keep looking.
Jun Bum Limcf974432016-03-31 14:47:24 +00001234 if (!inBoundsForPair(IsUnscaled, MinOffset, OffsetStride)) {
Jun Bum Lim47aece12018-04-27 18:44:37 +00001235 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits,
1236 UsedRegUnits, TRI);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001237 MemInsns.push_back(&MI);
Jun Bum Limcf974432016-03-31 14:47:24 +00001238 continue;
1239 }
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001240 // If the alignment requirements of the paired (scaled) instruction
1241 // can't express the offset of the unscaled input, bail and keep
1242 // looking.
1243 if (IsUnscaled && (alignTo(MinOffset, OffsetStride) != MinOffset)) {
Jun Bum Lim47aece12018-04-27 18:44:37 +00001244 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits,
1245 UsedRegUnits, TRI);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001246 MemInsns.push_back(&MI);
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001247 continue;
1248 }
Tim Northover3b0846e2014-05-24 12:50:23 +00001249 }
1250 // If the destination register of the loads is the same register, bail
1251 // and keep looking. A load-pair instruction with both destination
1252 // registers the same is UNPREDICTABLE and will result in an exception.
Jun Bum Limcf974432016-03-31 14:47:24 +00001253 if (MayLoad && Reg == getLdStRegOp(MI).getReg()) {
Jun Bum Lim47aece12018-04-27 18:44:37 +00001254 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits, UsedRegUnits,
1255 TRI);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001256 MemInsns.push_back(&MI);
Tim Northover3b0846e2014-05-24 12:50:23 +00001257 continue;
1258 }
1259
1260 // If the Rt of the second instruction was not modified or used between
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001261 // the two instructions and none of the instructions between the second
1262 // and first alias with the second, we can combine the second into the
1263 // first.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001264 if (ModifiedRegUnits.available(getLdStRegOp(MI).getReg()) &&
1265 !(MI.mayLoad() &&
1266 !UsedRegUnits.available(getLdStRegOp(MI).getReg())) &&
Chad Rosiera69dcb62017-03-17 14:19:55 +00001267 !mayAlias(MI, MemInsns, AA)) {
Chad Rosier96a18a92015-07-21 17:42:04 +00001268 Flags.setMergeForward(false);
Tim Northover3b0846e2014-05-24 12:50:23 +00001269 return MBBI;
1270 }
1271
1272 // Likewise, if the Rt of the first instruction is not modified or used
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001273 // between the two instructions and none of the instructions between the
1274 // first and the second alias with the first, we can combine the first
1275 // into the second.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001276 if (ModifiedRegUnits.available(getLdStRegOp(FirstMI).getReg()) &&
1277 !(MayLoad &&
1278 !UsedRegUnits.available(getLdStRegOp(FirstMI).getReg())) &&
Chad Rosiera69dcb62017-03-17 14:19:55 +00001279 !mayAlias(FirstMI, MemInsns, AA)) {
Chad Rosier96a18a92015-07-21 17:42:04 +00001280 Flags.setMergeForward(true);
Tim Northover3b0846e2014-05-24 12:50:23 +00001281 return MBBI;
1282 }
1283 // Unable to combine these instructions due to interference in between.
1284 // Keep looking.
1285 }
1286 }
1287
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001288 // If the instruction wasn't a matching load or store. Stop searching if we
1289 // encounter a call instruction that might modify memory.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001290 if (MI.isCall())
Tim Northover3b0846e2014-05-24 12:50:23 +00001291 return E;
1292
Jun Bum Lim47aece12018-04-27 18:44:37 +00001293 // Update modified / uses register units.
1294 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits, UsedRegUnits, TRI);
Tim Northover3b0846e2014-05-24 12:50:23 +00001295
1296 // Otherwise, if the base register is modified, we have no match, so
1297 // return early.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001298 if (!ModifiedRegUnits.available(BaseReg))
Tim Northover3b0846e2014-05-24 12:50:23 +00001299 return E;
Chad Rosierce8e5ab2015-05-21 21:36:46 +00001300
1301 // Update list of instructions that read/write memory.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001302 if (MI.mayLoadOrStore())
1303 MemInsns.push_back(&MI);
Tim Northover3b0846e2014-05-24 12:50:23 +00001304 }
1305 return E;
1306}
1307
1308MachineBasicBlock::iterator
Chad Rosier2dfd3542015-09-23 13:51:44 +00001309AArch64LoadStoreOpt::mergeUpdateInsn(MachineBasicBlock::iterator I,
1310 MachineBasicBlock::iterator Update,
1311 bool IsPreIdx) {
Tim Northover3b0846e2014-05-24 12:50:23 +00001312 assert((Update->getOpcode() == AArch64::ADDXri ||
1313 Update->getOpcode() == AArch64::SUBXri) &&
1314 "Unexpected base register update instruction to merge!");
1315 MachineBasicBlock::iterator NextI = I;
1316 // Return the instruction following the merged instruction, which is
1317 // the instruction following our unmerged load. Unless that's the add/sub
1318 // instruction we're merging, in which case it's the one after that.
1319 if (++NextI == Update)
1320 ++NextI;
1321
1322 int Value = Update->getOperand(2).getImm();
1323 assert(AArch64_AM::getShiftValue(Update->getOperand(3).getImm()) == 0 &&
Chad Rosier2dfd3542015-09-23 13:51:44 +00001324 "Can't merge 1 << 12 offset into pre-/post-indexed load / store");
Tim Northover3b0846e2014-05-24 12:50:23 +00001325 if (Update->getOpcode() == AArch64::SUBXri)
1326 Value = -Value;
1327
Chad Rosier2dfd3542015-09-23 13:51:44 +00001328 unsigned NewOpc = IsPreIdx ? getPreIndexedOpcode(I->getOpcode())
1329 : getPostIndexedOpcode(I->getOpcode());
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001330 MachineInstrBuilder MIB;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001331 if (!isPairedLdSt(*I)) {
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001332 // Non-paired instruction.
1333 MIB = BuildMI(*I->getParent(), I, I->getDebugLoc(), TII->get(NewOpc))
Diana Picus116bbab2017-01-13 09:58:52 +00001334 .add(getLdStRegOp(*Update))
1335 .add(getLdStRegOp(*I))
1336 .add(getLdStBaseOp(*I))
Chad Rosier3ada75f2016-01-28 15:38:24 +00001337 .addImm(Value)
Chandler Carruthc73c0302018-08-16 21:30:05 +00001338 .setMemRefs(I->memoperands())
Francis Visoiu Mistrih084e7d82018-03-14 17:10:58 +00001339 .setMIFlags(I->mergeFlagsWith(*Update));
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001340 } else {
1341 // Paired instruction.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001342 int Scale = getMemScale(*I);
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001343 MIB = BuildMI(*I->getParent(), I, I->getDebugLoc(), TII->get(NewOpc))
Diana Picus116bbab2017-01-13 09:58:52 +00001344 .add(getLdStRegOp(*Update))
1345 .add(getLdStRegOp(*I, 0))
1346 .add(getLdStRegOp(*I, 1))
1347 .add(getLdStBaseOp(*I))
Chad Rosier3ada75f2016-01-28 15:38:24 +00001348 .addImm(Value / Scale)
Chandler Carruthc73c0302018-08-16 21:30:05 +00001349 .setMemRefs(I->memoperands())
Francis Visoiu Mistrih084e7d82018-03-14 17:10:58 +00001350 .setMIFlags(I->mergeFlagsWith(*Update));
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001351 }
Tim Northover3b0846e2014-05-24 12:50:23 +00001352 (void)MIB;
1353
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001354 if (IsPreIdx) {
1355 ++NumPreFolded;
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001356 LLVM_DEBUG(dbgs() << "Creating pre-indexed load/store.");
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001357 } else {
1358 ++NumPostFolded;
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001359 LLVM_DEBUG(dbgs() << "Creating post-indexed load/store.");
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001360 }
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001361 LLVM_DEBUG(dbgs() << " Replacing instructions:\n ");
1362 LLVM_DEBUG(I->print(dbgs()));
1363 LLVM_DEBUG(dbgs() << " ");
1364 LLVM_DEBUG(Update->print(dbgs()));
1365 LLVM_DEBUG(dbgs() << " with instruction:\n ");
1366 LLVM_DEBUG(((MachineInstr *)MIB)->print(dbgs()));
1367 LLVM_DEBUG(dbgs() << "\n");
Tim Northover3b0846e2014-05-24 12:50:23 +00001368
1369 // Erase the old instructions for the block.
1370 I->eraseFromParent();
1371 Update->eraseFromParent();
1372
1373 return NextI;
1374}
1375
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001376bool AArch64LoadStoreOpt::isMatchingUpdateInsn(MachineInstr &MemMI,
1377 MachineInstr &MI,
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001378 unsigned BaseReg, int Offset) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001379 switch (MI.getOpcode()) {
Tim Northover3b0846e2014-05-24 12:50:23 +00001380 default:
1381 break;
1382 case AArch64::SUBXri:
Tim Northover3b0846e2014-05-24 12:50:23 +00001383 case AArch64::ADDXri:
1384 // Make sure it's a vanilla immediate operand, not a relocation or
1385 // anything else we can't handle.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001386 if (!MI.getOperand(2).isImm())
Tim Northover3b0846e2014-05-24 12:50:23 +00001387 break;
1388 // Watch out for 1 << 12 shifted value.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001389 if (AArch64_AM::getShiftValue(MI.getOperand(3).getImm()))
Tim Northover3b0846e2014-05-24 12:50:23 +00001390 break;
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001391
1392 // The update instruction source and destination register must be the
1393 // same as the load/store base register.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001394 if (MI.getOperand(0).getReg() != BaseReg ||
1395 MI.getOperand(1).getReg() != BaseReg)
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001396 break;
1397
1398 bool IsPairedInsn = isPairedLdSt(MemMI);
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001399 int UpdateOffset = MI.getOperand(2).getImm();
Eli Friedman8585e9d2016-08-12 20:28:02 +00001400 if (MI.getOpcode() == AArch64::SUBXri)
1401 UpdateOffset = -UpdateOffset;
1402
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001403 // For non-paired load/store instructions, the immediate must fit in a
1404 // signed 9-bit integer.
1405 if (!IsPairedInsn && (UpdateOffset > 255 || UpdateOffset < -256))
1406 break;
1407
1408 // For paired load/store instructions, the immediate must be a multiple of
1409 // the scaling factor. The scaled offset must also fit into a signed 7-bit
1410 // integer.
1411 if (IsPairedInsn) {
Chad Rosier32d4d372015-09-29 16:07:32 +00001412 int Scale = getMemScale(MemMI);
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001413 if (UpdateOffset % Scale != 0)
1414 break;
1415
1416 int ScaledOffset = UpdateOffset / Scale;
Eli Friedman8585e9d2016-08-12 20:28:02 +00001417 if (ScaledOffset > 63 || ScaledOffset < -64)
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001418 break;
Tim Northover3b0846e2014-05-24 12:50:23 +00001419 }
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001420
1421 // If we have a non-zero Offset, we check that it matches the amount
1422 // we're adding to the register.
Eli Friedman8585e9d2016-08-12 20:28:02 +00001423 if (!Offset || Offset == UpdateOffset)
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001424 return true;
Tim Northover3b0846e2014-05-24 12:50:23 +00001425 break;
1426 }
1427 return false;
1428}
1429
1430MachineBasicBlock::iterator AArch64LoadStoreOpt::findMatchingUpdateInsnForward(
Chad Rosier35706ad2016-02-04 21:26:02 +00001431 MachineBasicBlock::iterator I, int UnscaledOffset, unsigned Limit) {
Tim Northover3b0846e2014-05-24 12:50:23 +00001432 MachineBasicBlock::iterator E = I->getParent()->end();
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001433 MachineInstr &MemMI = *I;
Tim Northover3b0846e2014-05-24 12:50:23 +00001434 MachineBasicBlock::iterator MBBI = I;
Tim Northover3b0846e2014-05-24 12:50:23 +00001435
Chad Rosierf77e9092015-08-06 15:50:12 +00001436 unsigned BaseReg = getLdStBaseOp(MemMI).getReg();
Chad Rosier0b15e7c2015-10-01 13:33:31 +00001437 int MIUnscaledOffset = getLdStOffsetOp(MemMI).getImm() * getMemScale(MemMI);
Tim Northover3b0846e2014-05-24 12:50:23 +00001438
Chad Rosierb7c5b912015-10-01 13:43:05 +00001439 // Scan forward looking for post-index opportunities. Updating instructions
1440 // can't be formed if the memory instruction doesn't have the offset we're
1441 // looking for.
1442 if (MIUnscaledOffset != UnscaledOffset)
1443 return E;
1444
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001445 // If the base register overlaps a destination register, we can't
Tim Northover3b0846e2014-05-24 12:50:23 +00001446 // merge the update.
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001447 bool IsPairedInsn = isPairedLdSt(MemMI);
1448 for (unsigned i = 0, e = IsPairedInsn ? 2 : 1; i != e; ++i) {
1449 unsigned DestReg = getLdStRegOp(MemMI, i).getReg();
1450 if (DestReg == BaseReg || TRI->isSubRegister(BaseReg, DestReg))
1451 return E;
1452 }
Tim Northover3b0846e2014-05-24 12:50:23 +00001453
Jun Bum Lim47aece12018-04-27 18:44:37 +00001454 // Track which register units have been modified and used between the first
1455 // insn (inclusive) and the second insn.
1456 ModifiedRegUnits.clear();
1457 UsedRegUnits.clear();
Tim Northover3b0846e2014-05-24 12:50:23 +00001458 ++MBBI;
Chad Rosier35706ad2016-02-04 21:26:02 +00001459 for (unsigned Count = 0; MBBI != E && Count < Limit; ++MBBI) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001460 MachineInstr &MI = *MBBI;
Tim Northover3b0846e2014-05-24 12:50:23 +00001461
Geoff Berry4ff2e362016-07-21 15:20:25 +00001462 // Don't count transient instructions towards the search limit since there
1463 // may be different numbers of them if e.g. debug information is present.
1464 if (!MI.isTransient())
1465 ++Count;
Chad Rosier35706ad2016-02-04 21:26:02 +00001466
Tim Northover3b0846e2014-05-24 12:50:23 +00001467 // If we found a match, return it.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001468 if (isMatchingUpdateInsn(*I, MI, BaseReg, UnscaledOffset))
Tim Northover3b0846e2014-05-24 12:50:23 +00001469 return MBBI;
1470
1471 // Update the status of what the instruction clobbered and used.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001472 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits, UsedRegUnits, TRI);
Tim Northover3b0846e2014-05-24 12:50:23 +00001473
1474 // Otherwise, if the base register is used or modified, we have no match, so
1475 // return early.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001476 if (!ModifiedRegUnits.available(BaseReg) ||
1477 !UsedRegUnits.available(BaseReg))
Tim Northover3b0846e2014-05-24 12:50:23 +00001478 return E;
1479 }
1480 return E;
1481}
1482
1483MachineBasicBlock::iterator AArch64LoadStoreOpt::findMatchingUpdateInsnBackward(
Chad Rosier35706ad2016-02-04 21:26:02 +00001484 MachineBasicBlock::iterator I, unsigned Limit) {
Tim Northover3b0846e2014-05-24 12:50:23 +00001485 MachineBasicBlock::iterator B = I->getParent()->begin();
1486 MachineBasicBlock::iterator E = I->getParent()->end();
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001487 MachineInstr &MemMI = *I;
Tim Northover3b0846e2014-05-24 12:50:23 +00001488 MachineBasicBlock::iterator MBBI = I;
Tim Northover3b0846e2014-05-24 12:50:23 +00001489
Chad Rosierf77e9092015-08-06 15:50:12 +00001490 unsigned BaseReg = getLdStBaseOp(MemMI).getReg();
1491 int Offset = getLdStOffsetOp(MemMI).getImm();
Tim Northover3b0846e2014-05-24 12:50:23 +00001492
1493 // If the load/store is the first instruction in the block, there's obviously
1494 // not any matching update. Ditto if the memory offset isn't zero.
1495 if (MBBI == B || Offset != 0)
1496 return E;
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001497 // If the base register overlaps a destination register, we can't
Tim Northover3b0846e2014-05-24 12:50:23 +00001498 // merge the update.
Chad Rosier1bbd7fb2015-09-25 17:48:17 +00001499 bool IsPairedInsn = isPairedLdSt(MemMI);
1500 for (unsigned i = 0, e = IsPairedInsn ? 2 : 1; i != e; ++i) {
1501 unsigned DestReg = getLdStRegOp(MemMI, i).getReg();
1502 if (DestReg == BaseReg || TRI->isSubRegister(BaseReg, DestReg))
1503 return E;
1504 }
Tim Northover3b0846e2014-05-24 12:50:23 +00001505
Jun Bum Lim47aece12018-04-27 18:44:37 +00001506 // Track which register units have been modified and used between the first
1507 // insn (inclusive) and the second insn.
1508 ModifiedRegUnits.clear();
1509 UsedRegUnits.clear();
Geoff Berry173b14d2016-02-09 20:47:21 +00001510 unsigned Count = 0;
1511 do {
1512 --MBBI;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001513 MachineInstr &MI = *MBBI;
Tim Northover3b0846e2014-05-24 12:50:23 +00001514
Geoff Berry4ff2e362016-07-21 15:20:25 +00001515 // Don't count transient instructions towards the search limit since there
1516 // may be different numbers of them if e.g. debug information is present.
1517 if (!MI.isTransient())
Geoff Berry173b14d2016-02-09 20:47:21 +00001518 ++Count;
Chad Rosier35706ad2016-02-04 21:26:02 +00001519
Tim Northover3b0846e2014-05-24 12:50:23 +00001520 // If we found a match, return it.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001521 if (isMatchingUpdateInsn(*I, MI, BaseReg, Offset))
Tim Northover3b0846e2014-05-24 12:50:23 +00001522 return MBBI;
1523
1524 // Update the status of what the instruction clobbered and used.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001525 LiveRegUnits::accumulateUsedDefed(MI, ModifiedRegUnits, UsedRegUnits, TRI);
Tim Northover3b0846e2014-05-24 12:50:23 +00001526
1527 // Otherwise, if the base register is used or modified, we have no match, so
1528 // return early.
Jun Bum Lim47aece12018-04-27 18:44:37 +00001529 if (!ModifiedRegUnits.available(BaseReg) ||
1530 !UsedRegUnits.available(BaseReg))
Tim Northover3b0846e2014-05-24 12:50:23 +00001531 return E;
Geoff Berry173b14d2016-02-09 20:47:21 +00001532 } while (MBBI != B && Count < Limit);
Tim Northover3b0846e2014-05-24 12:50:23 +00001533 return E;
1534}
1535
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001536bool AArch64LoadStoreOpt::tryToPromoteLoadFromStore(
1537 MachineBasicBlock::iterator &MBBI) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001538 MachineInstr &MI = *MBBI;
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001539 // If this is a volatile load, don't mess with it.
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001540 if (MI.hasOrderedMemoryRef())
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001541 return false;
1542
1543 // Make sure this is a reg+imm.
1544 // FIXME: It is possible to extend it to handle reg+reg cases.
1545 if (!getLdStOffsetOp(MI).isImm())
1546 return false;
1547
Chad Rosier35706ad2016-02-04 21:26:02 +00001548 // Look backward up to LdStLimit instructions.
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001549 MachineBasicBlock::iterator StoreI;
Chad Rosier35706ad2016-02-04 21:26:02 +00001550 if (findMatchingStore(MBBI, LdStLimit, StoreI)) {
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001551 ++NumLoadsFromStoresPromoted;
1552 // Promote the load. Keeping the iterator straight is a
1553 // pain, so we let the merge routine tell us what the next instruction
1554 // is after it's done mucking about.
1555 MBBI = promoteLoadFromStore(MBBI, StoreI);
1556 return true;
1557 }
1558 return false;
1559}
1560
Chad Rosierd6daac42016-11-07 15:27:22 +00001561// Merge adjacent zero stores into a wider store.
1562bool AArch64LoadStoreOpt::tryToMergeZeroStInst(
Chad Rosier24c46ad2016-02-09 18:10:20 +00001563 MachineBasicBlock::iterator &MBBI) {
Chad Rosierd6daac42016-11-07 15:27:22 +00001564 assert(isPromotableZeroStoreInst(*MBBI) && "Expected narrow store.");
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001565 MachineInstr &MI = *MBBI;
1566 MachineBasicBlock::iterator E = MI.getParent()->end();
Chad Rosier24c46ad2016-02-09 18:10:20 +00001567
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001568 if (!TII->isCandidateToMergeOrPair(MI))
Chad Rosier24c46ad2016-02-09 18:10:20 +00001569 return false;
1570
1571 // Look ahead up to LdStLimit instructions for a mergable instruction.
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001572 LdStPairFlags Flags;
Jun Bum Lim397eb7b2016-02-12 15:25:39 +00001573 MachineBasicBlock::iterator MergeMI =
Jun Bum Limcf974432016-03-31 14:47:24 +00001574 findMatchingInsn(MBBI, Flags, LdStLimit, /* FindNarrowMerge = */ true);
Chad Rosierd7363db2016-02-09 19:09:22 +00001575 if (MergeMI != E) {
Chad Rosierd6daac42016-11-07 15:27:22 +00001576 ++NumZeroStoresPromoted;
1577
Chad Rosier24c46ad2016-02-09 18:10:20 +00001578 // Keeping the iterator straight is a pain, so we let the merge routine tell
1579 // us what the next instruction is after it's done mucking about.
Chad Rosierd6daac42016-11-07 15:27:22 +00001580 MBBI = mergeNarrowZeroStores(MBBI, MergeMI, Flags);
Chad Rosier24c46ad2016-02-09 18:10:20 +00001581 return true;
1582 }
1583 return false;
1584}
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001585
Chad Rosier24c46ad2016-02-09 18:10:20 +00001586// Find loads and stores that can be merged into a single load or store pair
1587// instruction.
1588bool AArch64LoadStoreOpt::tryToPairLdStInst(MachineBasicBlock::iterator &MBBI) {
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001589 MachineInstr &MI = *MBBI;
1590 MachineBasicBlock::iterator E = MI.getParent()->end();
Chad Rosier24c46ad2016-02-09 18:10:20 +00001591
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001592 if (!TII->isCandidateToMergeOrPair(MI))
Chad Rosier24c46ad2016-02-09 18:10:20 +00001593 return false;
1594
Chad Rosierfc3bf1f2016-02-10 15:52:46 +00001595 // Early exit if the offset is not possible to match. (6 bits of positive
1596 // range, plus allow an extra one in case we find a later insn that matches
1597 // with Offset-1)
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001598 bool IsUnscaled = TII->isUnscaledLdSt(MI);
Chad Rosierfc3bf1f2016-02-10 15:52:46 +00001599 int Offset = getLdStOffsetOp(MI).getImm();
1600 int OffsetStride = IsUnscaled ? getMemScale(MI) : 1;
Nirav Dave0f9d1112017-01-04 21:21:46 +00001601 // Allow one more for offset.
1602 if (Offset > 0)
1603 Offset -= OffsetStride;
Chad Rosierfc3bf1f2016-02-10 15:52:46 +00001604 if (!inBoundsForPair(IsUnscaled, Offset, OffsetStride))
1605 return false;
1606
Chad Rosier24c46ad2016-02-09 18:10:20 +00001607 // Look ahead up to LdStLimit instructions for a pairable instruction.
1608 LdStPairFlags Flags;
Jun Bum Limcf974432016-03-31 14:47:24 +00001609 MachineBasicBlock::iterator Paired =
1610 findMatchingInsn(MBBI, Flags, LdStLimit, /* FindNarrowMerge = */ false);
Chad Rosier24c46ad2016-02-09 18:10:20 +00001611 if (Paired != E) {
1612 ++NumPairCreated;
Duncan P. N. Exon Smithab53fd92016-07-08 20:29:42 +00001613 if (TII->isUnscaledLdSt(MI))
Chad Rosier24c46ad2016-02-09 18:10:20 +00001614 ++NumUnscaledPairCreated;
1615 // Keeping the iterator straight is a pain, so we let the merge routine tell
1616 // us what the next instruction is after it's done mucking about.
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001617 MBBI = mergePairedInsns(MBBI, Paired, Flags);
1618 return true;
1619 }
1620 return false;
1621}
1622
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001623bool AArch64LoadStoreOpt::tryToMergeLdStUpdate
1624 (MachineBasicBlock::iterator &MBBI) {
1625 MachineInstr &MI = *MBBI;
1626 MachineBasicBlock::iterator E = MI.getParent()->end();
1627 MachineBasicBlock::iterator Update;
1628
1629 // Look forward to try to form a post-index instruction. For example,
1630 // ldr x0, [x20]
1631 // add x20, x20, #32
1632 // merged into:
1633 // ldr x0, [x20], #32
1634 Update = findMatchingUpdateInsnForward(MBBI, 0, UpdateLimit);
1635 if (Update != E) {
1636 // Merge the update into the ld/st.
1637 MBBI = mergeUpdateInsn(MBBI, Update, /*IsPreIdx=*/false);
1638 return true;
1639 }
1640
1641 // Don't know how to handle unscaled pre/post-index versions below, so bail.
1642 if (TII->isUnscaledLdSt(MI.getOpcode()))
1643 return false;
1644
1645 // Look back to try to find a pre-index instruction. For example,
1646 // add x0, x0, #8
1647 // ldr x1, [x0]
1648 // merged into:
1649 // ldr x1, [x0, #8]!
1650 Update = findMatchingUpdateInsnBackward(MBBI, UpdateLimit);
1651 if (Update != E) {
1652 // Merge the update into the ld/st.
1653 MBBI = mergeUpdateInsn(MBBI, Update, /*IsPreIdx=*/true);
1654 return true;
1655 }
1656
1657 // The immediate in the load/store is scaled by the size of the memory
1658 // operation. The immediate in the add we're looking for,
1659 // however, is not, so adjust here.
1660 int UnscaledOffset = getLdStOffsetOp(MI).getImm() * getMemScale(MI);
1661
1662 // Look forward to try to find a post-index instruction. For example,
1663 // ldr x1, [x0, #64]
1664 // add x0, x0, #64
1665 // merged into:
1666 // ldr x1, [x0, #64]!
1667 Update = findMatchingUpdateInsnForward(MBBI, UnscaledOffset, UpdateLimit);
1668 if (Update != E) {
1669 // Merge the update into the ld/st.
1670 MBBI = mergeUpdateInsn(MBBI, Update, /*IsPreIdx=*/true);
1671 return true;
1672 }
1673
1674 return false;
1675}
1676
Jun Bum Lim22fe15e2015-11-06 16:27:47 +00001677bool AArch64LoadStoreOpt::optimizeBlock(MachineBasicBlock &MBB,
Chad Rosierd6daac42016-11-07 15:27:22 +00001678 bool EnableNarrowZeroStOpt) {
Tim Northover3b0846e2014-05-24 12:50:23 +00001679 bool Modified = false;
Chad Rosierdbdb1d62016-02-01 21:38:31 +00001680 // Four tranformations to do here:
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001681 // 1) Find loads that directly read from stores and promote them by
1682 // replacing with mov instructions. If the store is wider than the load,
1683 // the load will be replaced with a bitfield extract.
1684 // e.g.,
1685 // str w1, [x0, #4]
1686 // ldrh w2, [x0, #6]
1687 // ; becomes
1688 // str w1, [x0, #4]
NAKAMURA Takumife1202c2016-06-20 00:37:41 +00001689 // lsr w2, w1, #16
Tim Northover3b0846e2014-05-24 12:50:23 +00001690 for (MachineBasicBlock::iterator MBBI = MBB.begin(), E = MBB.end();
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001691 MBBI != E;) {
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001692 if (isPromotableLoadFromStore(*MBBI) && tryToPromoteLoadFromStore(MBBI))
1693 Modified = true;
1694 else
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001695 ++MBBI;
Jun Bum Lim6755c3b2015-12-22 16:36:16 +00001696 }
Chad Rosierd6daac42016-11-07 15:27:22 +00001697 // 2) Merge adjacent zero stores into a wider store.
Jun Bum Lim1de2d442016-02-05 20:02:03 +00001698 // e.g.,
1699 // strh wzr, [x0]
1700 // strh wzr, [x0, #2]
1701 // ; becomes
1702 // str wzr, [x0]
Chad Rosierd6daac42016-11-07 15:27:22 +00001703 // e.g.,
1704 // str wzr, [x0]
1705 // str wzr, [x0, #4]
1706 // ; becomes
1707 // str xzr, [x0]
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001708 if (EnableNarrowZeroStOpt)
1709 for (MachineBasicBlock::iterator MBBI = MBB.begin(), E = MBB.end();
1710 MBBI != E;) {
1711 if (isPromotableZeroStoreInst(*MBBI) && tryToMergeZeroStInst(MBBI))
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001712 Modified = true;
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001713 else
Jun Bum Lim33be4992016-05-06 15:08:57 +00001714 ++MBBI;
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001715 }
Chad Rosierdbdb1d62016-02-01 21:38:31 +00001716 // 3) Find loads and stores that can be merged into a single load or store
1717 // pair instruction.
1718 // e.g.,
1719 // ldr x0, [x2]
1720 // ldr x1, [x2, #8]
1721 // ; becomes
1722 // ldp x0, x1, [x2]
Jun Bum Limc9879ec2015-10-27 19:16:03 +00001723 for (MachineBasicBlock::iterator MBBI = MBB.begin(), E = MBB.end();
Tim Northover3b0846e2014-05-24 12:50:23 +00001724 MBBI != E;) {
Geoff Berry22dfbc52016-08-12 15:26:00 +00001725 if (TII->isPairableLdStInst(*MBBI) && tryToPairLdStInst(MBBI))
1726 Modified = true;
1727 else
Tim Northover3b0846e2014-05-24 12:50:23 +00001728 ++MBBI;
Tim Northover3b0846e2014-05-24 12:50:23 +00001729 }
Chad Rosierdbdb1d62016-02-01 21:38:31 +00001730 // 4) Find base register updates that can be merged into the load or store
1731 // as a base-reg writeback.
1732 // e.g.,
1733 // ldr x0, [x2]
1734 // add x2, x2, #4
1735 // ; becomes
1736 // ldr x0, [x2], #4
Tim Northover3b0846e2014-05-24 12:50:23 +00001737 for (MachineBasicBlock::iterator MBBI = MBB.begin(), E = MBB.end();
1738 MBBI != E;) {
Evandro Menezes5ba804b2017-11-15 21:06:22 +00001739 if (isMergeableLdStUpdate(*MBBI) && tryToMergeLdStUpdate(MBBI))
1740 Modified = true;
1741 else
Tim Northover3b0846e2014-05-24 12:50:23 +00001742 ++MBBI;
Tim Northover3b0846e2014-05-24 12:50:23 +00001743 }
1744
1745 return Modified;
1746}
1747
1748bool AArch64LoadStoreOpt::runOnMachineFunction(MachineFunction &Fn) {
Matthias Braunf1caa282017-12-15 22:22:58 +00001749 if (skipFunction(Fn.getFunction()))
Andrew Kaylor1ac98bb2016-04-25 21:58:52 +00001750 return false;
1751
Oliver Stannardd414c992015-11-10 11:04:18 +00001752 Subtarget = &static_cast<const AArch64Subtarget &>(Fn.getSubtarget());
1753 TII = static_cast<const AArch64InstrInfo *>(Subtarget->getInstrInfo());
1754 TRI = Subtarget->getRegisterInfo();
Chad Rosiera69dcb62017-03-17 14:19:55 +00001755 AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
Tim Northover3b0846e2014-05-24 12:50:23 +00001756
Jun Bum Lim47aece12018-04-27 18:44:37 +00001757 // Resize the modified and used register unit trackers. We do this once
1758 // per function and then clear the register units each time we optimize a load
1759 // or store.
1760 ModifiedRegUnits.init(*TRI);
1761 UsedRegUnits.init(*TRI);
Chad Rosierbba881e2016-02-02 15:02:30 +00001762
Tim Northover3b0846e2014-05-24 12:50:23 +00001763 bool Modified = false;
Chad Rosier10c7aaa2016-11-11 14:10:12 +00001764 bool enableNarrowZeroStOpt = !Subtarget->requiresStrictAlign();
Tim Northover3b0846e2014-05-24 12:50:23 +00001765 for (auto &MBB : Fn)
Chad Rosierd6daac42016-11-07 15:27:22 +00001766 Modified |= optimizeBlock(MBB, enableNarrowZeroStOpt);
Tim Northover3b0846e2014-05-24 12:50:23 +00001767
1768 return Modified;
1769}
1770
Chad Rosier8ade0342016-11-11 19:52:45 +00001771// FIXME: Do we need/want a pre-alloc pass like ARM has to try to keep loads and
1772// stores near one another? Note: The pre-RA instruction scheduler already has
1773// hooks to try and schedule pairable loads/stores together to improve pairing
1774// opportunities. Thus, pre-RA pairing pass may not be worth the effort.
Tim Northover3b0846e2014-05-24 12:50:23 +00001775
Chad Rosier3f8b09d2016-02-09 19:42:19 +00001776// FIXME: When pairing store instructions it's very possible for this pass to
1777// hoist a store with a KILL marker above another use (without a KILL marker).
1778// The resulting IR is invalid, but nothing uses the KILL markers after this
1779// pass, so it's never caused a problem in practice.
1780
Chad Rosier43f5c842015-08-05 12:40:13 +00001781/// createAArch64LoadStoreOptimizationPass - returns an instance of the
1782/// load / store optimization pass.
Tim Northover3b0846e2014-05-24 12:50:23 +00001783FunctionPass *llvm::createAArch64LoadStoreOptimizationPass() {
1784 return new AArch64LoadStoreOpt();
1785}