1 //===- MemCpyOptimizer.cpp - Optimize use of memcpy and friends -----------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This pass performs various transformations related to eliminating memcpy 11 // calls, or transforming sets of stores into memset's. 12 // 13 //===----------------------------------------------------------------------===// 14 15 #include "llvm/Transforms/Scalar.h" 16 #include "llvm/ADT/SmallVector.h" 17 #include "llvm/ADT/Statistic.h" 18 #include "llvm/Analysis/AliasAnalysis.h" 19 #include "llvm/Analysis/AssumptionCache.h" 20 #include "llvm/Analysis/GlobalsModRef.h" 21 #include "llvm/Analysis/MemoryDependenceAnalysis.h" 22 #include "llvm/Analysis/TargetLibraryInfo.h" 23 #include "llvm/Analysis/ValueTracking.h" 24 #include "llvm/IR/DataLayout.h" 25 #include "llvm/IR/Dominators.h" 26 #include "llvm/IR/GetElementPtrTypeIterator.h" 27 #include "llvm/IR/GlobalVariable.h" 28 #include "llvm/IR/IRBuilder.h" 29 #include "llvm/IR/Instructions.h" 30 #include "llvm/IR/IntrinsicInst.h" 31 #include "llvm/Support/Debug.h" 32 #include "llvm/Support/raw_ostream.h" 33 #include "llvm/Transforms/Utils/Local.h" 34 #include <algorithm> 35 using namespace llvm; 36 37 #define DEBUG_TYPE "memcpyopt" 38 39 STATISTIC(NumMemCpyInstr, "Number of memcpy instructions deleted"); 40 STATISTIC(NumMemSetInfer, "Number of memsets inferred"); 41 STATISTIC(NumMoveToCpy, "Number of memmoves converted to memcpy"); 42 STATISTIC(NumCpyToSet, "Number of memcpys converted to memset"); 43 44 static int64_t GetOffsetFromIndex(const GEPOperator *GEP, unsigned Idx, 45 bool &VariableIdxFound, 46 const DataLayout &DL) { 47 // Skip over the first indices. 48 gep_type_iterator GTI = gep_type_begin(GEP); 49 for (unsigned i = 1; i != Idx; ++i, ++GTI) 50 /*skip along*/; 51 52 // Compute the offset implied by the rest of the indices. 53 int64_t Offset = 0; 54 for (unsigned i = Idx, e = GEP->getNumOperands(); i != e; ++i, ++GTI) { 55 ConstantInt *OpC = dyn_cast<ConstantInt>(GEP->getOperand(i)); 56 if (!OpC) 57 return VariableIdxFound = true; 58 if (OpC->isZero()) continue; // No offset. 59 60 // Handle struct indices, which add their field offset to the pointer. 61 if (StructType *STy = dyn_cast<StructType>(*GTI)) { 62 Offset += DL.getStructLayout(STy)->getElementOffset(OpC->getZExtValue()); 63 continue; 64 } 65 66 // Otherwise, we have a sequential type like an array or vector. Multiply 67 // the index by the ElementSize. 68 uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType()); 69 Offset += Size*OpC->getSExtValue(); 70 } 71 72 return Offset; 73 } 74 75 /// Return true if Ptr1 is provably equal to Ptr2 plus a constant offset, and 76 /// return that constant offset. For example, Ptr1 might be &A[42], and Ptr2 77 /// might be &A[40]. In this case offset would be -8. 78 static bool IsPointerOffset(Value *Ptr1, Value *Ptr2, int64_t &Offset, 79 const DataLayout &DL) { 80 Ptr1 = Ptr1->stripPointerCasts(); 81 Ptr2 = Ptr2->stripPointerCasts(); 82 83 // Handle the trivial case first. 84 if (Ptr1 == Ptr2) { 85 Offset = 0; 86 return true; 87 } 88 89 GEPOperator *GEP1 = dyn_cast<GEPOperator>(Ptr1); 90 GEPOperator *GEP2 = dyn_cast<GEPOperator>(Ptr2); 91 92 bool VariableIdxFound = false; 93 94 // If one pointer is a GEP and the other isn't, then see if the GEP is a 95 // constant offset from the base, as in "P" and "gep P, 1". 96 if (GEP1 && !GEP2 && GEP1->getOperand(0)->stripPointerCasts() == Ptr2) { 97 Offset = -GetOffsetFromIndex(GEP1, 1, VariableIdxFound, DL); 98 return !VariableIdxFound; 99 } 100 101 if (GEP2 && !GEP1 && GEP2->getOperand(0)->stripPointerCasts() == Ptr1) { 102 Offset = GetOffsetFromIndex(GEP2, 1, VariableIdxFound, DL); 103 return !VariableIdxFound; 104 } 105 106 // Right now we handle the case when Ptr1/Ptr2 are both GEPs with an identical 107 // base. After that base, they may have some number of common (and 108 // potentially variable) indices. After that they handle some constant 109 // offset, which determines their offset from each other. At this point, we 110 // handle no other case. 111 if (!GEP1 || !GEP2 || GEP1->getOperand(0) != GEP2->getOperand(0)) 112 return false; 113 114 // Skip any common indices and track the GEP types. 115 unsigned Idx = 1; 116 for (; Idx != GEP1->getNumOperands() && Idx != GEP2->getNumOperands(); ++Idx) 117 if (GEP1->getOperand(Idx) != GEP2->getOperand(Idx)) 118 break; 119 120 int64_t Offset1 = GetOffsetFromIndex(GEP1, Idx, VariableIdxFound, DL); 121 int64_t Offset2 = GetOffsetFromIndex(GEP2, Idx, VariableIdxFound, DL); 122 if (VariableIdxFound) return false; 123 124 Offset = Offset2-Offset1; 125 return true; 126 } 127 128 129 /// Represents a range of memset'd bytes with the ByteVal value. 130 /// This allows us to analyze stores like: 131 /// store 0 -> P+1 132 /// store 0 -> P+0 133 /// store 0 -> P+3 134 /// store 0 -> P+2 135 /// which sometimes happens with stores to arrays of structs etc. When we see 136 /// the first store, we make a range [1, 2). The second store extends the range 137 /// to [0, 2). The third makes a new range [2, 3). The fourth store joins the 138 /// two ranges into [0, 3) which is memset'able. 139 namespace { 140 struct MemsetRange { 141 // Start/End - A semi range that describes the span that this range covers. 142 // The range is closed at the start and open at the end: [Start, End). 143 int64_t Start, End; 144 145 /// StartPtr - The getelementptr instruction that points to the start of the 146 /// range. 147 Value *StartPtr; 148 149 /// Alignment - The known alignment of the first store. 150 unsigned Alignment; 151 152 /// TheStores - The actual stores that make up this range. 153 SmallVector<Instruction*, 16> TheStores; 154 155 bool isProfitableToUseMemset(const DataLayout &DL) const; 156 }; 157 } // end anon namespace 158 159 bool MemsetRange::isProfitableToUseMemset(const DataLayout &DL) const { 160 // If we found more than 4 stores to merge or 16 bytes, use memset. 161 if (TheStores.size() >= 4 || End-Start >= 16) return true; 162 163 // If there is nothing to merge, don't do anything. 164 if (TheStores.size() < 2) return false; 165 166 // If any of the stores are a memset, then it is always good to extend the 167 // memset. 168 for (Instruction *SI : TheStores) 169 if (!isa<StoreInst>(SI)) 170 return true; 171 172 // Assume that the code generator is capable of merging pairs of stores 173 // together if it wants to. 174 if (TheStores.size() == 2) return false; 175 176 // If we have fewer than 8 stores, it can still be worthwhile to do this. 177 // For example, merging 4 i8 stores into an i32 store is useful almost always. 178 // However, merging 2 32-bit stores isn't useful on a 32-bit architecture (the 179 // memset will be split into 2 32-bit stores anyway) and doing so can 180 // pessimize the llvm optimizer. 181 // 182 // Since we don't have perfect knowledge here, make some assumptions: assume 183 // the maximum GPR width is the same size as the largest legal integer 184 // size. If so, check to see whether we will end up actually reducing the 185 // number of stores used. 186 unsigned Bytes = unsigned(End-Start); 187 unsigned MaxIntSize = DL.getLargestLegalIntTypeSize(); 188 if (MaxIntSize == 0) 189 MaxIntSize = 1; 190 unsigned NumPointerStores = Bytes / MaxIntSize; 191 192 // Assume the remaining bytes if any are done a byte at a time. 193 unsigned NumByteStores = Bytes % MaxIntSize; 194 195 // If we will reduce the # stores (according to this heuristic), do the 196 // transformation. This encourages merging 4 x i8 -> i32 and 2 x i16 -> i32 197 // etc. 198 return TheStores.size() > NumPointerStores+NumByteStores; 199 } 200 201 202 namespace { 203 class MemsetRanges { 204 /// A sorted list of the memset ranges. 205 SmallVector<MemsetRange, 8> Ranges; 206 typedef SmallVectorImpl<MemsetRange>::iterator range_iterator; 207 const DataLayout &DL; 208 public: 209 MemsetRanges(const DataLayout &DL) : DL(DL) {} 210 211 typedef SmallVectorImpl<MemsetRange>::const_iterator const_iterator; 212 const_iterator begin() const { return Ranges.begin(); } 213 const_iterator end() const { return Ranges.end(); } 214 bool empty() const { return Ranges.empty(); } 215 216 void addInst(int64_t OffsetFromFirst, Instruction *Inst) { 217 if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) 218 addStore(OffsetFromFirst, SI); 219 else 220 addMemSet(OffsetFromFirst, cast<MemSetInst>(Inst)); 221 } 222 223 void addStore(int64_t OffsetFromFirst, StoreInst *SI) { 224 int64_t StoreSize = DL.getTypeStoreSize(SI->getOperand(0)->getType()); 225 226 addRange(OffsetFromFirst, StoreSize, 227 SI->getPointerOperand(), SI->getAlignment(), SI); 228 } 229 230 void addMemSet(int64_t OffsetFromFirst, MemSetInst *MSI) { 231 int64_t Size = cast<ConstantInt>(MSI->getLength())->getZExtValue(); 232 addRange(OffsetFromFirst, Size, MSI->getDest(), MSI->getAlignment(), MSI); 233 } 234 235 void addRange(int64_t Start, int64_t Size, Value *Ptr, 236 unsigned Alignment, Instruction *Inst); 237 238 }; 239 240 } // end anon namespace 241 242 243 /// Add a new store to the MemsetRanges data structure. This adds a 244 /// new range for the specified store at the specified offset, merging into 245 /// existing ranges as appropriate. 246 void MemsetRanges::addRange(int64_t Start, int64_t Size, Value *Ptr, 247 unsigned Alignment, Instruction *Inst) { 248 int64_t End = Start+Size; 249 250 range_iterator I = std::lower_bound(Ranges.begin(), Ranges.end(), Start, 251 [](const MemsetRange &LHS, int64_t RHS) { return LHS.End < RHS; }); 252 253 // We now know that I == E, in which case we didn't find anything to merge 254 // with, or that Start <= I->End. If End < I->Start or I == E, then we need 255 // to insert a new range. Handle this now. 256 if (I == Ranges.end() || End < I->Start) { 257 MemsetRange &R = *Ranges.insert(I, MemsetRange()); 258 R.Start = Start; 259 R.End = End; 260 R.StartPtr = Ptr; 261 R.Alignment = Alignment; 262 R.TheStores.push_back(Inst); 263 return; 264 } 265 266 // This store overlaps with I, add it. 267 I->TheStores.push_back(Inst); 268 269 // At this point, we may have an interval that completely contains our store. 270 // If so, just add it to the interval and return. 271 if (I->Start <= Start && I->End >= End) 272 return; 273 274 // Now we know that Start <= I->End and End >= I->Start so the range overlaps 275 // but is not entirely contained within the range. 276 277 // See if the range extends the start of the range. In this case, it couldn't 278 // possibly cause it to join the prior range, because otherwise we would have 279 // stopped on *it*. 280 if (Start < I->Start) { 281 I->Start = Start; 282 I->StartPtr = Ptr; 283 I->Alignment = Alignment; 284 } 285 286 // Now we know that Start <= I->End and Start >= I->Start (so the startpoint 287 // is in or right at the end of I), and that End >= I->Start. Extend I out to 288 // End. 289 if (End > I->End) { 290 I->End = End; 291 range_iterator NextI = I; 292 while (++NextI != Ranges.end() && End >= NextI->Start) { 293 // Merge the range in. 294 I->TheStores.append(NextI->TheStores.begin(), NextI->TheStores.end()); 295 if (NextI->End > I->End) 296 I->End = NextI->End; 297 Ranges.erase(NextI); 298 NextI = I; 299 } 300 } 301 } 302 303 //===----------------------------------------------------------------------===// 304 // MemCpyOpt Pass 305 //===----------------------------------------------------------------------===// 306 307 namespace { 308 class MemCpyOpt : public FunctionPass { 309 MemoryDependenceResults *MD; 310 TargetLibraryInfo *TLI; 311 public: 312 static char ID; // Pass identification, replacement for typeid 313 MemCpyOpt() : FunctionPass(ID) { 314 initializeMemCpyOptPass(*PassRegistry::getPassRegistry()); 315 MD = nullptr; 316 TLI = nullptr; 317 } 318 319 bool runOnFunction(Function &F) override; 320 321 private: 322 // This transformation requires dominator postdominator info 323 void getAnalysisUsage(AnalysisUsage &AU) const override { 324 AU.setPreservesCFG(); 325 AU.addRequired<AssumptionCacheTracker>(); 326 AU.addRequired<DominatorTreeWrapperPass>(); 327 AU.addRequired<MemoryDependenceWrapperPass>(); 328 AU.addRequired<AAResultsWrapperPass>(); 329 AU.addRequired<TargetLibraryInfoWrapperPass>(); 330 AU.addPreserved<GlobalsAAWrapperPass>(); 331 AU.addPreserved<MemoryDependenceWrapperPass>(); 332 } 333 334 // Helper functions 335 bool processStore(StoreInst *SI, BasicBlock::iterator &BBI); 336 bool processMemSet(MemSetInst *SI, BasicBlock::iterator &BBI); 337 bool processMemCpy(MemCpyInst *M); 338 bool processMemMove(MemMoveInst *M); 339 bool performCallSlotOptzn(Instruction *cpy, Value *cpyDst, Value *cpySrc, 340 uint64_t cpyLen, unsigned cpyAlign, CallInst *C); 341 bool processMemCpyMemCpyDependence(MemCpyInst *M, MemCpyInst *MDep); 342 bool processMemSetMemCpyDependence(MemCpyInst *M, MemSetInst *MDep); 343 bool performMemCpyToMemSetOptzn(MemCpyInst *M, MemSetInst *MDep); 344 bool processByValArgument(CallSite CS, unsigned ArgNo); 345 Instruction *tryMergingIntoMemset(Instruction *I, Value *StartPtr, 346 Value *ByteVal); 347 348 bool iterateOnFunction(Function &F); 349 }; 350 351 char MemCpyOpt::ID = 0; 352 } 353 354 /// The public interface to this file... 355 FunctionPass *llvm::createMemCpyOptPass() { return new MemCpyOpt(); } 356 357 INITIALIZE_PASS_BEGIN(MemCpyOpt, "memcpyopt", "MemCpy Optimization", 358 false, false) 359 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker) 360 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass) 361 INITIALIZE_PASS_DEPENDENCY(MemoryDependenceWrapperPass) 362 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass) 363 INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass) 364 INITIALIZE_PASS_DEPENDENCY(GlobalsAAWrapperPass) 365 INITIALIZE_PASS_END(MemCpyOpt, "memcpyopt", "MemCpy Optimization", 366 false, false) 367 368 /// When scanning forward over instructions, we look for some other patterns to 369 /// fold away. In particular, this looks for stores to neighboring locations of 370 /// memory. If it sees enough consecutive ones, it attempts to merge them 371 /// together into a memcpy/memset. 372 Instruction *MemCpyOpt::tryMergingIntoMemset(Instruction *StartInst, 373 Value *StartPtr, Value *ByteVal) { 374 const DataLayout &DL = StartInst->getModule()->getDataLayout(); 375 376 // Okay, so we now have a single store that can be splatable. Scan to find 377 // all subsequent stores of the same value to offset from the same pointer. 378 // Join these together into ranges, so we can decide whether contiguous blocks 379 // are stored. 380 MemsetRanges Ranges(DL); 381 382 BasicBlock::iterator BI(StartInst); 383 for (++BI; !isa<TerminatorInst>(BI); ++BI) { 384 if (!isa<StoreInst>(BI) && !isa<MemSetInst>(BI)) { 385 // If the instruction is readnone, ignore it, otherwise bail out. We 386 // don't even allow readonly here because we don't want something like: 387 // A[1] = 2; strlen(A); A[2] = 2; -> memcpy(A, ...); strlen(A). 388 if (BI->mayWriteToMemory() || BI->mayReadFromMemory()) 389 break; 390 continue; 391 } 392 393 if (StoreInst *NextStore = dyn_cast<StoreInst>(BI)) { 394 // If this is a store, see if we can merge it in. 395 if (!NextStore->isSimple()) break; 396 397 // Check to see if this stored value is of the same byte-splattable value. 398 if (ByteVal != isBytewiseValue(NextStore->getOperand(0))) 399 break; 400 401 // Check to see if this store is to a constant offset from the start ptr. 402 int64_t Offset; 403 if (!IsPointerOffset(StartPtr, NextStore->getPointerOperand(), Offset, 404 DL)) 405 break; 406 407 Ranges.addStore(Offset, NextStore); 408 } else { 409 MemSetInst *MSI = cast<MemSetInst>(BI); 410 411 if (MSI->isVolatile() || ByteVal != MSI->getValue() || 412 !isa<ConstantInt>(MSI->getLength())) 413 break; 414 415 // Check to see if this store is to a constant offset from the start ptr. 416 int64_t Offset; 417 if (!IsPointerOffset(StartPtr, MSI->getDest(), Offset, DL)) 418 break; 419 420 Ranges.addMemSet(Offset, MSI); 421 } 422 } 423 424 // If we have no ranges, then we just had a single store with nothing that 425 // could be merged in. This is a very common case of course. 426 if (Ranges.empty()) 427 return nullptr; 428 429 // If we had at least one store that could be merged in, add the starting 430 // store as well. We try to avoid this unless there is at least something 431 // interesting as a small compile-time optimization. 432 Ranges.addInst(0, StartInst); 433 434 // If we create any memsets, we put it right before the first instruction that 435 // isn't part of the memset block. This ensure that the memset is dominated 436 // by any addressing instruction needed by the start of the block. 437 IRBuilder<> Builder(&*BI); 438 439 // Now that we have full information about ranges, loop over the ranges and 440 // emit memset's for anything big enough to be worthwhile. 441 Instruction *AMemSet = nullptr; 442 for (const MemsetRange &Range : Ranges) { 443 444 if (Range.TheStores.size() == 1) continue; 445 446 // If it is profitable to lower this range to memset, do so now. 447 if (!Range.isProfitableToUseMemset(DL)) 448 continue; 449 450 // Otherwise, we do want to transform this! Create a new memset. 451 // Get the starting pointer of the block. 452 StartPtr = Range.StartPtr; 453 454 // Determine alignment 455 unsigned Alignment = Range.Alignment; 456 if (Alignment == 0) { 457 Type *EltType = 458 cast<PointerType>(StartPtr->getType())->getElementType(); 459 Alignment = DL.getABITypeAlignment(EltType); 460 } 461 462 AMemSet = 463 Builder.CreateMemSet(StartPtr, ByteVal, Range.End-Range.Start, Alignment); 464 465 DEBUG(dbgs() << "Replace stores:\n"; 466 for (Instruction *SI : Range.TheStores) 467 dbgs() << *SI << '\n'; 468 dbgs() << "With: " << *AMemSet << '\n'); 469 470 if (!Range.TheStores.empty()) 471 AMemSet->setDebugLoc(Range.TheStores[0]->getDebugLoc()); 472 473 // Zap all the stores. 474 for (Instruction *SI : Range.TheStores) { 475 MD->removeInstruction(SI); 476 SI->eraseFromParent(); 477 } 478 ++NumMemSetInfer; 479 } 480 481 return AMemSet; 482 } 483 484 static unsigned findCommonAlignment(const DataLayout &DL, const StoreInst *SI, 485 const LoadInst *LI) { 486 unsigned StoreAlign = SI->getAlignment(); 487 if (!StoreAlign) 488 StoreAlign = DL.getABITypeAlignment(SI->getOperand(0)->getType()); 489 unsigned LoadAlign = LI->getAlignment(); 490 if (!LoadAlign) 491 LoadAlign = DL.getABITypeAlignment(LI->getType()); 492 493 return std::min(StoreAlign, LoadAlign); 494 } 495 496 bool MemCpyOpt::processStore(StoreInst *SI, BasicBlock::iterator &BBI) { 497 if (!SI->isSimple()) return false; 498 499 // Avoid merging nontemporal stores since the resulting 500 // memcpy/memset would not be able to preserve the nontemporal hint. 501 // In theory we could teach how to propagate the !nontemporal metadata to 502 // memset calls. However, that change would force the backend to 503 // conservatively expand !nontemporal memset calls back to sequences of 504 // store instructions (effectively undoing the merging). 505 if (SI->getMetadata(LLVMContext::MD_nontemporal)) 506 return false; 507 508 const DataLayout &DL = SI->getModule()->getDataLayout(); 509 510 // Load to store forwarding can be interpreted as memcpy. 511 if (LoadInst *LI = dyn_cast<LoadInst>(SI->getOperand(0))) { 512 if (LI->isSimple() && LI->hasOneUse() && 513 LI->getParent() == SI->getParent()) { 514 515 auto *T = LI->getType(); 516 if (T->isAggregateType()) { 517 AliasAnalysis &AA = getAnalysis<AAResultsWrapperPass>().getAAResults(); 518 MemoryLocation LoadLoc = MemoryLocation::get(LI); 519 520 // We use alias analysis to check if an instruction may store to 521 // the memory we load from in between the load and the store. If 522 // such an instruction is found, we try to promote there instead 523 // of at the store position. 524 Instruction *P = SI; 525 for (BasicBlock::iterator I = ++LI->getIterator(), E = SI->getIterator(); 526 I != E; ++I) { 527 if (!(AA.getModRefInfo(&*I, LoadLoc) & MRI_Mod)) 528 continue; 529 530 // We found an instruction that may write to the loaded memory. 531 // We can try to promote at this position instead of the store 532 // position if nothing alias the store memory after this and the store 533 // destination is not in the range. 534 P = &*I; 535 for (; I != E; ++I) { 536 MemoryLocation StoreLoc = MemoryLocation::get(SI); 537 if (&*I == SI->getOperand(1) || 538 AA.getModRefInfo(&*I, StoreLoc) != MRI_NoModRef) { 539 P = nullptr; 540 break; 541 } 542 } 543 544 break; 545 } 546 547 // If a valid insertion position is found, then we can promote 548 // the load/store pair to a memcpy. 549 if (P) { 550 // If we load from memory that may alias the memory we store to, 551 // memmove must be used to preserve semantic. If not, memcpy can 552 // be used. 553 bool UseMemMove = false; 554 if (!AA.isNoAlias(MemoryLocation::get(SI), LoadLoc)) 555 UseMemMove = true; 556 557 unsigned Align = findCommonAlignment(DL, SI, LI); 558 uint64_t Size = DL.getTypeStoreSize(T); 559 560 IRBuilder<> Builder(P); 561 Instruction *M; 562 if (UseMemMove) 563 M = Builder.CreateMemMove(SI->getPointerOperand(), 564 LI->getPointerOperand(), Size, 565 Align, SI->isVolatile()); 566 else 567 M = Builder.CreateMemCpy(SI->getPointerOperand(), 568 LI->getPointerOperand(), Size, 569 Align, SI->isVolatile()); 570 571 DEBUG(dbgs() << "Promoting " << *LI << " to " << *SI 572 << " => " << *M << "\n"); 573 574 MD->removeInstruction(SI); 575 SI->eraseFromParent(); 576 MD->removeInstruction(LI); 577 LI->eraseFromParent(); 578 ++NumMemCpyInstr; 579 580 // Make sure we do not invalidate the iterator. 581 BBI = M->getIterator(); 582 return true; 583 } 584 } 585 586 // Detect cases where we're performing call slot forwarding, but 587 // happen to be using a load-store pair to implement it, rather than 588 // a memcpy. 589 MemDepResult ldep = MD->getDependency(LI); 590 CallInst *C = nullptr; 591 if (ldep.isClobber() && !isa<MemCpyInst>(ldep.getInst())) 592 C = dyn_cast<CallInst>(ldep.getInst()); 593 594 if (C) { 595 // Check that nothing touches the dest of the "copy" between 596 // the call and the store. 597 AliasAnalysis &AA = getAnalysis<AAResultsWrapperPass>().getAAResults(); 598 MemoryLocation StoreLoc = MemoryLocation::get(SI); 599 for (BasicBlock::iterator I = --SI->getIterator(), E = C->getIterator(); 600 I != E; --I) { 601 if (AA.getModRefInfo(&*I, StoreLoc) != MRI_NoModRef) { 602 C = nullptr; 603 break; 604 } 605 } 606 } 607 608 if (C) { 609 bool changed = performCallSlotOptzn( 610 LI, SI->getPointerOperand()->stripPointerCasts(), 611 LI->getPointerOperand()->stripPointerCasts(), 612 DL.getTypeStoreSize(SI->getOperand(0)->getType()), 613 findCommonAlignment(DL, SI, LI), C); 614 if (changed) { 615 MD->removeInstruction(SI); 616 SI->eraseFromParent(); 617 MD->removeInstruction(LI); 618 LI->eraseFromParent(); 619 ++NumMemCpyInstr; 620 return true; 621 } 622 } 623 } 624 } 625 626 // There are two cases that are interesting for this code to handle: memcpy 627 // and memset. Right now we only handle memset. 628 629 // Ensure that the value being stored is something that can be memset'able a 630 // byte at a time like "0" or "-1" or any width, as well as things like 631 // 0xA0A0A0A0 and 0.0. 632 auto *V = SI->getOperand(0); 633 if (Value *ByteVal = isBytewiseValue(V)) { 634 if (Instruction *I = tryMergingIntoMemset(SI, SI->getPointerOperand(), 635 ByteVal)) { 636 BBI = I->getIterator(); // Don't invalidate iterator. 637 return true; 638 } 639 640 // If we have an aggregate, we try to promote it to memset regardless 641 // of opportunity for merging as it can expose optimization opportunities 642 // in subsequent passes. 643 auto *T = V->getType(); 644 if (T->isAggregateType()) { 645 uint64_t Size = DL.getTypeStoreSize(T); 646 unsigned Align = SI->getAlignment(); 647 if (!Align) 648 Align = DL.getABITypeAlignment(T); 649 IRBuilder<> Builder(SI); 650 auto *M = Builder.CreateMemSet(SI->getPointerOperand(), ByteVal, 651 Size, Align, SI->isVolatile()); 652 653 DEBUG(dbgs() << "Promoting " << *SI << " to " << *M << "\n"); 654 655 MD->removeInstruction(SI); 656 SI->eraseFromParent(); 657 NumMemSetInfer++; 658 659 // Make sure we do not invalidate the iterator. 660 BBI = M->getIterator(); 661 return true; 662 } 663 } 664 665 return false; 666 } 667 668 bool MemCpyOpt::processMemSet(MemSetInst *MSI, BasicBlock::iterator &BBI) { 669 // See if there is another memset or store neighboring this memset which 670 // allows us to widen out the memset to do a single larger store. 671 if (isa<ConstantInt>(MSI->getLength()) && !MSI->isVolatile()) 672 if (Instruction *I = tryMergingIntoMemset(MSI, MSI->getDest(), 673 MSI->getValue())) { 674 BBI = I->getIterator(); // Don't invalidate iterator. 675 return true; 676 } 677 return false; 678 } 679 680 681 /// Takes a memcpy and a call that it depends on, 682 /// and checks for the possibility of a call slot optimization by having 683 /// the call write its result directly into the destination of the memcpy. 684 bool MemCpyOpt::performCallSlotOptzn(Instruction *cpy, 685 Value *cpyDest, Value *cpySrc, 686 uint64_t cpyLen, unsigned cpyAlign, 687 CallInst *C) { 688 // The general transformation to keep in mind is 689 // 690 // call @func(..., src, ...) 691 // memcpy(dest, src, ...) 692 // 693 // -> 694 // 695 // memcpy(dest, src, ...) 696 // call @func(..., dest, ...) 697 // 698 // Since moving the memcpy is technically awkward, we additionally check that 699 // src only holds uninitialized values at the moment of the call, meaning that 700 // the memcpy can be discarded rather than moved. 701 702 // Deliberately get the source and destination with bitcasts stripped away, 703 // because we'll need to do type comparisons based on the underlying type. 704 CallSite CS(C); 705 706 // Require that src be an alloca. This simplifies the reasoning considerably. 707 AllocaInst *srcAlloca = dyn_cast<AllocaInst>(cpySrc); 708 if (!srcAlloca) 709 return false; 710 711 ConstantInt *srcArraySize = dyn_cast<ConstantInt>(srcAlloca->getArraySize()); 712 if (!srcArraySize) 713 return false; 714 715 const DataLayout &DL = cpy->getModule()->getDataLayout(); 716 uint64_t srcSize = DL.getTypeAllocSize(srcAlloca->getAllocatedType()) * 717 srcArraySize->getZExtValue(); 718 719 if (cpyLen < srcSize) 720 return false; 721 722 // Check that accessing the first srcSize bytes of dest will not cause a 723 // trap. Otherwise the transform is invalid since it might cause a trap 724 // to occur earlier than it otherwise would. 725 if (AllocaInst *A = dyn_cast<AllocaInst>(cpyDest)) { 726 // The destination is an alloca. Check it is larger than srcSize. 727 ConstantInt *destArraySize = dyn_cast<ConstantInt>(A->getArraySize()); 728 if (!destArraySize) 729 return false; 730 731 uint64_t destSize = DL.getTypeAllocSize(A->getAllocatedType()) * 732 destArraySize->getZExtValue(); 733 734 if (destSize < srcSize) 735 return false; 736 } else if (Argument *A = dyn_cast<Argument>(cpyDest)) { 737 if (A->getDereferenceableBytes() < srcSize) { 738 // If the destination is an sret parameter then only accesses that are 739 // outside of the returned struct type can trap. 740 if (!A->hasStructRetAttr()) 741 return false; 742 743 Type *StructTy = cast<PointerType>(A->getType())->getElementType(); 744 if (!StructTy->isSized()) { 745 // The call may never return and hence the copy-instruction may never 746 // be executed, and therefore it's not safe to say "the destination 747 // has at least <cpyLen> bytes, as implied by the copy-instruction", 748 return false; 749 } 750 751 uint64_t destSize = DL.getTypeAllocSize(StructTy); 752 if (destSize < srcSize) 753 return false; 754 } 755 } else { 756 return false; 757 } 758 759 // Check that dest points to memory that is at least as aligned as src. 760 unsigned srcAlign = srcAlloca->getAlignment(); 761 if (!srcAlign) 762 srcAlign = DL.getABITypeAlignment(srcAlloca->getAllocatedType()); 763 bool isDestSufficientlyAligned = srcAlign <= cpyAlign; 764 // If dest is not aligned enough and we can't increase its alignment then 765 // bail out. 766 if (!isDestSufficientlyAligned && !isa<AllocaInst>(cpyDest)) 767 return false; 768 769 // Check that src is not accessed except via the call and the memcpy. This 770 // guarantees that it holds only undefined values when passed in (so the final 771 // memcpy can be dropped), that it is not read or written between the call and 772 // the memcpy, and that writing beyond the end of it is undefined. 773 SmallVector<User*, 8> srcUseList(srcAlloca->user_begin(), 774 srcAlloca->user_end()); 775 while (!srcUseList.empty()) { 776 User *U = srcUseList.pop_back_val(); 777 778 if (isa<BitCastInst>(U) || isa<AddrSpaceCastInst>(U)) { 779 for (User *UU : U->users()) 780 srcUseList.push_back(UU); 781 continue; 782 } 783 if (GetElementPtrInst *G = dyn_cast<GetElementPtrInst>(U)) { 784 if (!G->hasAllZeroIndices()) 785 return false; 786 787 for (User *UU : U->users()) 788 srcUseList.push_back(UU); 789 continue; 790 } 791 if (const IntrinsicInst *IT = dyn_cast<IntrinsicInst>(U)) 792 if (IT->getIntrinsicID() == Intrinsic::lifetime_start || 793 IT->getIntrinsicID() == Intrinsic::lifetime_end) 794 continue; 795 796 if (U != C && U != cpy) 797 return false; 798 } 799 800 // Check that src isn't captured by the called function since the 801 // transformation can cause aliasing issues in that case. 802 for (unsigned i = 0, e = CS.arg_size(); i != e; ++i) 803 if (CS.getArgument(i) == cpySrc && !CS.doesNotCapture(i)) 804 return false; 805 806 // Since we're changing the parameter to the callsite, we need to make sure 807 // that what would be the new parameter dominates the callsite. 808 DominatorTree &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree(); 809 if (Instruction *cpyDestInst = dyn_cast<Instruction>(cpyDest)) 810 if (!DT.dominates(cpyDestInst, C)) 811 return false; 812 813 // In addition to knowing that the call does not access src in some 814 // unexpected manner, for example via a global, which we deduce from 815 // the use analysis, we also need to know that it does not sneakily 816 // access dest. We rely on AA to figure this out for us. 817 AliasAnalysis &AA = getAnalysis<AAResultsWrapperPass>().getAAResults(); 818 ModRefInfo MR = AA.getModRefInfo(C, cpyDest, srcSize); 819 // If necessary, perform additional analysis. 820 if (MR != MRI_NoModRef) 821 MR = AA.callCapturesBefore(C, cpyDest, srcSize, &DT); 822 if (MR != MRI_NoModRef) 823 return false; 824 825 // All the checks have passed, so do the transformation. 826 bool changedArgument = false; 827 for (unsigned i = 0; i < CS.arg_size(); ++i) 828 if (CS.getArgument(i)->stripPointerCasts() == cpySrc) { 829 Value *Dest = cpySrc->getType() == cpyDest->getType() ? cpyDest 830 : CastInst::CreatePointerCast(cpyDest, cpySrc->getType(), 831 cpyDest->getName(), C); 832 changedArgument = true; 833 if (CS.getArgument(i)->getType() == Dest->getType()) 834 CS.setArgument(i, Dest); 835 else 836 CS.setArgument(i, CastInst::CreatePointerCast(Dest, 837 CS.getArgument(i)->getType(), Dest->getName(), C)); 838 } 839 840 if (!changedArgument) 841 return false; 842 843 // If the destination wasn't sufficiently aligned then increase its alignment. 844 if (!isDestSufficientlyAligned) { 845 assert(isa<AllocaInst>(cpyDest) && "Can only increase alloca alignment!"); 846 cast<AllocaInst>(cpyDest)->setAlignment(srcAlign); 847 } 848 849 // Drop any cached information about the call, because we may have changed 850 // its dependence information by changing its parameter. 851 MD->removeInstruction(C); 852 853 // Update AA metadata 854 // FIXME: MD_tbaa_struct and MD_mem_parallel_loop_access should also be 855 // handled here, but combineMetadata doesn't support them yet 856 unsigned KnownIDs[] = {LLVMContext::MD_tbaa, LLVMContext::MD_alias_scope, 857 LLVMContext::MD_noalias, 858 LLVMContext::MD_invariant_group}; 859 combineMetadata(C, cpy, KnownIDs); 860 861 // Remove the memcpy. 862 MD->removeInstruction(cpy); 863 ++NumMemCpyInstr; 864 865 return true; 866 } 867 868 /// We've found that the (upward scanning) memory dependence of memcpy 'M' is 869 /// the memcpy 'MDep'. Try to simplify M to copy from MDep's input if we can. 870 bool MemCpyOpt::processMemCpyMemCpyDependence(MemCpyInst *M, MemCpyInst *MDep) { 871 // We can only transforms memcpy's where the dest of one is the source of the 872 // other. 873 if (M->getSource() != MDep->getDest() || MDep->isVolatile()) 874 return false; 875 876 // If dep instruction is reading from our current input, then it is a noop 877 // transfer and substituting the input won't change this instruction. Just 878 // ignore the input and let someone else zap MDep. This handles cases like: 879 // memcpy(a <- a) 880 // memcpy(b <- a) 881 if (M->getSource() == MDep->getSource()) 882 return false; 883 884 // Second, the length of the memcpy's must be the same, or the preceding one 885 // must be larger than the following one. 886 ConstantInt *MDepLen = dyn_cast<ConstantInt>(MDep->getLength()); 887 ConstantInt *MLen = dyn_cast<ConstantInt>(M->getLength()); 888 if (!MDepLen || !MLen || MDepLen->getZExtValue() < MLen->getZExtValue()) 889 return false; 890 891 AliasAnalysis &AA = getAnalysis<AAResultsWrapperPass>().getAAResults(); 892 893 // Verify that the copied-from memory doesn't change in between the two 894 // transfers. For example, in: 895 // memcpy(a <- b) 896 // *b = 42; 897 // memcpy(c <- a) 898 // It would be invalid to transform the second memcpy into memcpy(c <- b). 899 // 900 // TODO: If the code between M and MDep is transparent to the destination "c", 901 // then we could still perform the xform by moving M up to the first memcpy. 902 // 903 // NOTE: This is conservative, it will stop on any read from the source loc, 904 // not just the defining memcpy. 905 MemDepResult SourceDep = 906 MD->getPointerDependencyFrom(MemoryLocation::getForSource(MDep), false, 907 M->getIterator(), M->getParent()); 908 if (!SourceDep.isClobber() || SourceDep.getInst() != MDep) 909 return false; 910 911 // If the dest of the second might alias the source of the first, then the 912 // source and dest might overlap. We still want to eliminate the intermediate 913 // value, but we have to generate a memmove instead of memcpy. 914 bool UseMemMove = false; 915 if (!AA.isNoAlias(MemoryLocation::getForDest(M), 916 MemoryLocation::getForSource(MDep))) 917 UseMemMove = true; 918 919 // If all checks passed, then we can transform M. 920 921 // Make sure to use the lesser of the alignment of the source and the dest 922 // since we're changing where we're reading from, but don't want to increase 923 // the alignment past what can be read from or written to. 924 // TODO: Is this worth it if we're creating a less aligned memcpy? For 925 // example we could be moving from movaps -> movq on x86. 926 unsigned Align = std::min(MDep->getAlignment(), M->getAlignment()); 927 928 IRBuilder<> Builder(M); 929 if (UseMemMove) 930 Builder.CreateMemMove(M->getRawDest(), MDep->getRawSource(), M->getLength(), 931 Align, M->isVolatile()); 932 else 933 Builder.CreateMemCpy(M->getRawDest(), MDep->getRawSource(), M->getLength(), 934 Align, M->isVolatile()); 935 936 // Remove the instruction we're replacing. 937 MD->removeInstruction(M); 938 M->eraseFromParent(); 939 ++NumMemCpyInstr; 940 return true; 941 } 942 943 /// We've found that the (upward scanning) memory dependence of \p MemCpy is 944 /// \p MemSet. Try to simplify \p MemSet to only set the trailing bytes that 945 /// weren't copied over by \p MemCpy. 946 /// 947 /// In other words, transform: 948 /// \code 949 /// memset(dst, c, dst_size); 950 /// memcpy(dst, src, src_size); 951 /// \endcode 952 /// into: 953 /// \code 954 /// memcpy(dst, src, src_size); 955 /// memset(dst + src_size, c, dst_size <= src_size ? 0 : dst_size - src_size); 956 /// \endcode 957 bool MemCpyOpt::processMemSetMemCpyDependence(MemCpyInst *MemCpy, 958 MemSetInst *MemSet) { 959 // We can only transform memset/memcpy with the same destination. 960 if (MemSet->getDest() != MemCpy->getDest()) 961 return false; 962 963 // Check that there are no other dependencies on the memset destination. 964 MemDepResult DstDepInfo = 965 MD->getPointerDependencyFrom(MemoryLocation::getForDest(MemSet), false, 966 MemCpy->getIterator(), MemCpy->getParent()); 967 if (DstDepInfo.getInst() != MemSet) 968 return false; 969 970 // Use the same i8* dest as the memcpy, killing the memset dest if different. 971 Value *Dest = MemCpy->getRawDest(); 972 Value *DestSize = MemSet->getLength(); 973 Value *SrcSize = MemCpy->getLength(); 974 975 // By default, create an unaligned memset. 976 unsigned Align = 1; 977 // If Dest is aligned, and SrcSize is constant, use the minimum alignment 978 // of the sum. 979 const unsigned DestAlign = 980 std::max(MemSet->getAlignment(), MemCpy->getAlignment()); 981 if (DestAlign > 1) 982 if (ConstantInt *SrcSizeC = dyn_cast<ConstantInt>(SrcSize)) 983 Align = MinAlign(SrcSizeC->getZExtValue(), DestAlign); 984 985 IRBuilder<> Builder(MemCpy); 986 987 // If the sizes have different types, zext the smaller one. 988 if (DestSize->getType() != SrcSize->getType()) { 989 if (DestSize->getType()->getIntegerBitWidth() > 990 SrcSize->getType()->getIntegerBitWidth()) 991 SrcSize = Builder.CreateZExt(SrcSize, DestSize->getType()); 992 else 993 DestSize = Builder.CreateZExt(DestSize, SrcSize->getType()); 994 } 995 996 Value *MemsetLen = 997 Builder.CreateSelect(Builder.CreateICmpULE(DestSize, SrcSize), 998 ConstantInt::getNullValue(DestSize->getType()), 999 Builder.CreateSub(DestSize, SrcSize)); 1000 Builder.CreateMemSet(Builder.CreateGEP(Dest, SrcSize), MemSet->getOperand(1), 1001 MemsetLen, Align); 1002 1003 MD->removeInstruction(MemSet); 1004 MemSet->eraseFromParent(); 1005 return true; 1006 } 1007 1008 /// Transform memcpy to memset when its source was just memset. 1009 /// In other words, turn: 1010 /// \code 1011 /// memset(dst1, c, dst1_size); 1012 /// memcpy(dst2, dst1, dst2_size); 1013 /// \endcode 1014 /// into: 1015 /// \code 1016 /// memset(dst1, c, dst1_size); 1017 /// memset(dst2, c, dst2_size); 1018 /// \endcode 1019 /// When dst2_size <= dst1_size. 1020 /// 1021 /// The \p MemCpy must have a Constant length. 1022 bool MemCpyOpt::performMemCpyToMemSetOptzn(MemCpyInst *MemCpy, 1023 MemSetInst *MemSet) { 1024 // This only makes sense on memcpy(..., memset(...), ...). 1025 if (MemSet->getRawDest() != MemCpy->getRawSource()) 1026 return false; 1027 1028 ConstantInt *CopySize = cast<ConstantInt>(MemCpy->getLength()); 1029 ConstantInt *MemSetSize = dyn_cast<ConstantInt>(MemSet->getLength()); 1030 // Make sure the memcpy doesn't read any more than what the memset wrote. 1031 // Don't worry about sizes larger than i64. 1032 if (!MemSetSize || CopySize->getZExtValue() > MemSetSize->getZExtValue()) 1033 return false; 1034 1035 IRBuilder<> Builder(MemCpy); 1036 Builder.CreateMemSet(MemCpy->getRawDest(), MemSet->getOperand(1), 1037 CopySize, MemCpy->getAlignment()); 1038 return true; 1039 } 1040 1041 /// Perform simplification of memcpy's. If we have memcpy A 1042 /// which copies X to Y, and memcpy B which copies Y to Z, then we can rewrite 1043 /// B to be a memcpy from X to Z (or potentially a memmove, depending on 1044 /// circumstances). This allows later passes to remove the first memcpy 1045 /// altogether. 1046 bool MemCpyOpt::processMemCpy(MemCpyInst *M) { 1047 // We can only optimize non-volatile memcpy's. 1048 if (M->isVolatile()) return false; 1049 1050 // If the source and destination of the memcpy are the same, then zap it. 1051 if (M->getSource() == M->getDest()) { 1052 MD->removeInstruction(M); 1053 M->eraseFromParent(); 1054 return false; 1055 } 1056 1057 // If copying from a constant, try to turn the memcpy into a memset. 1058 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(M->getSource())) 1059 if (GV->isConstant() && GV->hasDefinitiveInitializer()) 1060 if (Value *ByteVal = isBytewiseValue(GV->getInitializer())) { 1061 IRBuilder<> Builder(M); 1062 Builder.CreateMemSet(M->getRawDest(), ByteVal, M->getLength(), 1063 M->getAlignment(), false); 1064 MD->removeInstruction(M); 1065 M->eraseFromParent(); 1066 ++NumCpyToSet; 1067 return true; 1068 } 1069 1070 MemDepResult DepInfo = MD->getDependency(M); 1071 1072 // Try to turn a partially redundant memset + memcpy into 1073 // memcpy + smaller memset. We don't need the memcpy size for this. 1074 if (DepInfo.isClobber()) 1075 if (MemSetInst *MDep = dyn_cast<MemSetInst>(DepInfo.getInst())) 1076 if (processMemSetMemCpyDependence(M, MDep)) 1077 return true; 1078 1079 // The optimizations after this point require the memcpy size. 1080 ConstantInt *CopySize = dyn_cast<ConstantInt>(M->getLength()); 1081 if (!CopySize) return false; 1082 1083 // There are four possible optimizations we can do for memcpy: 1084 // a) memcpy-memcpy xform which exposes redundance for DSE. 1085 // b) call-memcpy xform for return slot optimization. 1086 // c) memcpy from freshly alloca'd space or space that has just started its 1087 // lifetime copies undefined data, and we can therefore eliminate the 1088 // memcpy in favor of the data that was already at the destination. 1089 // d) memcpy from a just-memset'd source can be turned into memset. 1090 if (DepInfo.isClobber()) { 1091 if (CallInst *C = dyn_cast<CallInst>(DepInfo.getInst())) { 1092 if (performCallSlotOptzn(M, M->getDest(), M->getSource(), 1093 CopySize->getZExtValue(), M->getAlignment(), 1094 C)) { 1095 MD->removeInstruction(M); 1096 M->eraseFromParent(); 1097 return true; 1098 } 1099 } 1100 } 1101 1102 MemoryLocation SrcLoc = MemoryLocation::getForSource(M); 1103 MemDepResult SrcDepInfo = MD->getPointerDependencyFrom( 1104 SrcLoc, true, M->getIterator(), M->getParent()); 1105 1106 if (SrcDepInfo.isClobber()) { 1107 if (MemCpyInst *MDep = dyn_cast<MemCpyInst>(SrcDepInfo.getInst())) 1108 return processMemCpyMemCpyDependence(M, MDep); 1109 } else if (SrcDepInfo.isDef()) { 1110 Instruction *I = SrcDepInfo.getInst(); 1111 bool hasUndefContents = false; 1112 1113 if (isa<AllocaInst>(I)) { 1114 hasUndefContents = true; 1115 } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) { 1116 if (II->getIntrinsicID() == Intrinsic::lifetime_start) 1117 if (ConstantInt *LTSize = dyn_cast<ConstantInt>(II->getArgOperand(0))) 1118 if (LTSize->getZExtValue() >= CopySize->getZExtValue()) 1119 hasUndefContents = true; 1120 } 1121 1122 if (hasUndefContents) { 1123 MD->removeInstruction(M); 1124 M->eraseFromParent(); 1125 ++NumMemCpyInstr; 1126 return true; 1127 } 1128 } 1129 1130 if (SrcDepInfo.isClobber()) 1131 if (MemSetInst *MDep = dyn_cast<MemSetInst>(SrcDepInfo.getInst())) 1132 if (performMemCpyToMemSetOptzn(M, MDep)) { 1133 MD->removeInstruction(M); 1134 M->eraseFromParent(); 1135 ++NumCpyToSet; 1136 return true; 1137 } 1138 1139 return false; 1140 } 1141 1142 /// Transforms memmove calls to memcpy calls when the src/dst are guaranteed 1143 /// not to alias. 1144 bool MemCpyOpt::processMemMove(MemMoveInst *M) { 1145 AliasAnalysis &AA = getAnalysis<AAResultsWrapperPass>().getAAResults(); 1146 1147 if (!TLI->has(LibFunc::memmove)) 1148 return false; 1149 1150 // See if the pointers alias. 1151 if (!AA.isNoAlias(MemoryLocation::getForDest(M), 1152 MemoryLocation::getForSource(M))) 1153 return false; 1154 1155 DEBUG(dbgs() << "MemCpyOpt: Optimizing memmove -> memcpy: " << *M << "\n"); 1156 1157 // If not, then we know we can transform this. 1158 Type *ArgTys[3] = { M->getRawDest()->getType(), 1159 M->getRawSource()->getType(), 1160 M->getLength()->getType() }; 1161 M->setCalledFunction(Intrinsic::getDeclaration(M->getModule(), 1162 Intrinsic::memcpy, ArgTys)); 1163 1164 // MemDep may have over conservative information about this instruction, just 1165 // conservatively flush it from the cache. 1166 MD->removeInstruction(M); 1167 1168 ++NumMoveToCpy; 1169 return true; 1170 } 1171 1172 /// This is called on every byval argument in call sites. 1173 bool MemCpyOpt::processByValArgument(CallSite CS, unsigned ArgNo) { 1174 const DataLayout &DL = CS.getCaller()->getParent()->getDataLayout(); 1175 // Find out what feeds this byval argument. 1176 Value *ByValArg = CS.getArgument(ArgNo); 1177 Type *ByValTy = cast<PointerType>(ByValArg->getType())->getElementType(); 1178 uint64_t ByValSize = DL.getTypeAllocSize(ByValTy); 1179 MemDepResult DepInfo = MD->getPointerDependencyFrom( 1180 MemoryLocation(ByValArg, ByValSize), true, 1181 CS.getInstruction()->getIterator(), CS.getInstruction()->getParent()); 1182 if (!DepInfo.isClobber()) 1183 return false; 1184 1185 // If the byval argument isn't fed by a memcpy, ignore it. If it is fed by 1186 // a memcpy, see if we can byval from the source of the memcpy instead of the 1187 // result. 1188 MemCpyInst *MDep = dyn_cast<MemCpyInst>(DepInfo.getInst()); 1189 if (!MDep || MDep->isVolatile() || 1190 ByValArg->stripPointerCasts() != MDep->getDest()) 1191 return false; 1192 1193 // The length of the memcpy must be larger or equal to the size of the byval. 1194 ConstantInt *C1 = dyn_cast<ConstantInt>(MDep->getLength()); 1195 if (!C1 || C1->getValue().getZExtValue() < ByValSize) 1196 return false; 1197 1198 // Get the alignment of the byval. If the call doesn't specify the alignment, 1199 // then it is some target specific value that we can't know. 1200 unsigned ByValAlign = CS.getParamAlignment(ArgNo+1); 1201 if (ByValAlign == 0) return false; 1202 1203 // If it is greater than the memcpy, then we check to see if we can force the 1204 // source of the memcpy to the alignment we need. If we fail, we bail out. 1205 AssumptionCache &AC = 1206 getAnalysis<AssumptionCacheTracker>().getAssumptionCache( 1207 *CS->getParent()->getParent()); 1208 DominatorTree &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree(); 1209 if (MDep->getAlignment() < ByValAlign && 1210 getOrEnforceKnownAlignment(MDep->getSource(), ByValAlign, DL, 1211 CS.getInstruction(), &AC, &DT) < ByValAlign) 1212 return false; 1213 1214 // Verify that the copied-from memory doesn't change in between the memcpy and 1215 // the byval call. 1216 // memcpy(a <- b) 1217 // *b = 42; 1218 // foo(*a) 1219 // It would be invalid to transform the second memcpy into foo(*b). 1220 // 1221 // NOTE: This is conservative, it will stop on any read from the source loc, 1222 // not just the defining memcpy. 1223 MemDepResult SourceDep = MD->getPointerDependencyFrom( 1224 MemoryLocation::getForSource(MDep), false, 1225 CS.getInstruction()->getIterator(), MDep->getParent()); 1226 if (!SourceDep.isClobber() || SourceDep.getInst() != MDep) 1227 return false; 1228 1229 Value *TmpCast = MDep->getSource(); 1230 if (MDep->getSource()->getType() != ByValArg->getType()) 1231 TmpCast = new BitCastInst(MDep->getSource(), ByValArg->getType(), 1232 "tmpcast", CS.getInstruction()); 1233 1234 DEBUG(dbgs() << "MemCpyOpt: Forwarding memcpy to byval:\n" 1235 << " " << *MDep << "\n" 1236 << " " << *CS.getInstruction() << "\n"); 1237 1238 // Otherwise we're good! Update the byval argument. 1239 CS.setArgument(ArgNo, TmpCast); 1240 ++NumMemCpyInstr; 1241 return true; 1242 } 1243 1244 /// Executes one iteration of MemCpyOpt. 1245 bool MemCpyOpt::iterateOnFunction(Function &F) { 1246 bool MadeChange = false; 1247 1248 // Walk all instruction in the function. 1249 for (Function::iterator BB = F.begin(), BBE = F.end(); BB != BBE; ++BB) { 1250 for (BasicBlock::iterator BI = BB->begin(), BE = BB->end(); BI != BE;) { 1251 // Avoid invalidating the iterator. 1252 Instruction *I = &*BI++; 1253 1254 bool RepeatInstruction = false; 1255 1256 if (StoreInst *SI = dyn_cast<StoreInst>(I)) 1257 MadeChange |= processStore(SI, BI); 1258 else if (MemSetInst *M = dyn_cast<MemSetInst>(I)) 1259 RepeatInstruction = processMemSet(M, BI); 1260 else if (MemCpyInst *M = dyn_cast<MemCpyInst>(I)) 1261 RepeatInstruction = processMemCpy(M); 1262 else if (MemMoveInst *M = dyn_cast<MemMoveInst>(I)) 1263 RepeatInstruction = processMemMove(M); 1264 else if (auto CS = CallSite(I)) { 1265 for (unsigned i = 0, e = CS.arg_size(); i != e; ++i) 1266 if (CS.isByValArgument(i)) 1267 MadeChange |= processByValArgument(CS, i); 1268 } 1269 1270 // Reprocess the instruction if desired. 1271 if (RepeatInstruction) { 1272 if (BI != BB->begin()) --BI; 1273 MadeChange = true; 1274 } 1275 } 1276 } 1277 1278 return MadeChange; 1279 } 1280 1281 /// This is the main transformation entry point for a function. 1282 bool MemCpyOpt::runOnFunction(Function &F) { 1283 if (skipOptnoneFunction(F)) 1284 return false; 1285 1286 bool MadeChange = false; 1287 MD = &getAnalysis<MemoryDependenceWrapperPass>().getMemDep(); 1288 TLI = &getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(); 1289 1290 // If we don't have at least memset and memcpy, there is little point of doing 1291 // anything here. These are required by a freestanding implementation, so if 1292 // even they are disabled, there is no point in trying hard. 1293 if (!TLI->has(LibFunc::memset) || !TLI->has(LibFunc::memcpy)) 1294 return false; 1295 1296 while (1) { 1297 if (!iterateOnFunction(F)) 1298 break; 1299 MadeChange = true; 1300 } 1301 1302 MD = nullptr; 1303 return MadeChange; 1304 } 1305