| File: | src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Transforms/Scalar/MemCpyOptimizer.cpp |
| Warning: | line 767, column 29 Called C++ object pointer is null |
Press '?' to see keyboard shortcuts
Keyboard shortcuts:
| 1 | //===- MemCpyOptimizer.cpp - Optimize use of memcpy and friends -----------===// | ||||||||||||||
| 2 | // | ||||||||||||||
| 3 | // 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 | ||||||||||||||
| 6 | // | ||||||||||||||
| 7 | //===----------------------------------------------------------------------===// | ||||||||||||||
| 8 | // | ||||||||||||||
| 9 | // This pass performs various transformations related to eliminating memcpy | ||||||||||||||
| 10 | // calls, or transforming sets of stores into memset's. | ||||||||||||||
| 11 | // | ||||||||||||||
| 12 | //===----------------------------------------------------------------------===// | ||||||||||||||
| 13 | |||||||||||||||
| 14 | #include "llvm/Transforms/Scalar/MemCpyOptimizer.h" | ||||||||||||||
| 15 | #include "llvm/ADT/DenseSet.h" | ||||||||||||||
| 16 | #include "llvm/ADT/None.h" | ||||||||||||||
| 17 | #include "llvm/ADT/STLExtras.h" | ||||||||||||||
| 18 | #include "llvm/ADT/SmallVector.h" | ||||||||||||||
| 19 | #include "llvm/ADT/Statistic.h" | ||||||||||||||
| 20 | #include "llvm/ADT/iterator_range.h" | ||||||||||||||
| 21 | #include "llvm/Analysis/AliasAnalysis.h" | ||||||||||||||
| 22 | #include "llvm/Analysis/AssumptionCache.h" | ||||||||||||||
| 23 | #include "llvm/Analysis/GlobalsModRef.h" | ||||||||||||||
| 24 | #include "llvm/Analysis/Loads.h" | ||||||||||||||
| 25 | #include "llvm/Analysis/MemoryDependenceAnalysis.h" | ||||||||||||||
| 26 | #include "llvm/Analysis/MemoryLocation.h" | ||||||||||||||
| 27 | #include "llvm/Analysis/MemorySSA.h" | ||||||||||||||
| 28 | #include "llvm/Analysis/MemorySSAUpdater.h" | ||||||||||||||
| 29 | #include "llvm/Analysis/TargetLibraryInfo.h" | ||||||||||||||
| 30 | #include "llvm/Analysis/ValueTracking.h" | ||||||||||||||
| 31 | #include "llvm/IR/Argument.h" | ||||||||||||||
| 32 | #include "llvm/IR/BasicBlock.h" | ||||||||||||||
| 33 | #include "llvm/IR/Constants.h" | ||||||||||||||
| 34 | #include "llvm/IR/DataLayout.h" | ||||||||||||||
| 35 | #include "llvm/IR/DerivedTypes.h" | ||||||||||||||
| 36 | #include "llvm/IR/Dominators.h" | ||||||||||||||
| 37 | #include "llvm/IR/Function.h" | ||||||||||||||
| 38 | #include "llvm/IR/GetElementPtrTypeIterator.h" | ||||||||||||||
| 39 | #include "llvm/IR/GlobalVariable.h" | ||||||||||||||
| 40 | #include "llvm/IR/IRBuilder.h" | ||||||||||||||
| 41 | #include "llvm/IR/InstrTypes.h" | ||||||||||||||
| 42 | #include "llvm/IR/Instruction.h" | ||||||||||||||
| 43 | #include "llvm/IR/Instructions.h" | ||||||||||||||
| 44 | #include "llvm/IR/IntrinsicInst.h" | ||||||||||||||
| 45 | #include "llvm/IR/Intrinsics.h" | ||||||||||||||
| 46 | #include "llvm/IR/LLVMContext.h" | ||||||||||||||
| 47 | #include "llvm/IR/Module.h" | ||||||||||||||
| 48 | #include "llvm/IR/Operator.h" | ||||||||||||||
| 49 | #include "llvm/IR/PassManager.h" | ||||||||||||||
| 50 | #include "llvm/IR/Type.h" | ||||||||||||||
| 51 | #include "llvm/IR/User.h" | ||||||||||||||
| 52 | #include "llvm/IR/Value.h" | ||||||||||||||
| 53 | #include "llvm/InitializePasses.h" | ||||||||||||||
| 54 | #include "llvm/Pass.h" | ||||||||||||||
| 55 | #include "llvm/Support/Casting.h" | ||||||||||||||
| 56 | #include "llvm/Support/Debug.h" | ||||||||||||||
| 57 | #include "llvm/Support/MathExtras.h" | ||||||||||||||
| 58 | #include "llvm/Support/raw_ostream.h" | ||||||||||||||
| 59 | #include "llvm/Transforms/Scalar.h" | ||||||||||||||
| 60 | #include "llvm/Transforms/Utils/Local.h" | ||||||||||||||
| 61 | #include <algorithm> | ||||||||||||||
| 62 | #include <cassert> | ||||||||||||||
| 63 | #include <cstdint> | ||||||||||||||
| 64 | #include <utility> | ||||||||||||||
| 65 | |||||||||||||||
| 66 | using namespace llvm; | ||||||||||||||
| 67 | |||||||||||||||
| 68 | #define DEBUG_TYPE"memcpyopt" "memcpyopt" | ||||||||||||||
| 69 | |||||||||||||||
| 70 | static cl::opt<bool> | ||||||||||||||
| 71 | EnableMemorySSA("enable-memcpyopt-memoryssa", cl::init(true), cl::Hidden, | ||||||||||||||
| 72 | cl::desc("Use MemorySSA-backed MemCpyOpt.")); | ||||||||||||||
| 73 | |||||||||||||||
| 74 | STATISTIC(NumMemCpyInstr, "Number of memcpy instructions deleted")static llvm::Statistic NumMemCpyInstr = {"memcpyopt", "NumMemCpyInstr" , "Number of memcpy instructions deleted"}; | ||||||||||||||
| 75 | STATISTIC(NumMemSetInfer, "Number of memsets inferred")static llvm::Statistic NumMemSetInfer = {"memcpyopt", "NumMemSetInfer" , "Number of memsets inferred"}; | ||||||||||||||
| 76 | STATISTIC(NumMoveToCpy, "Number of memmoves converted to memcpy")static llvm::Statistic NumMoveToCpy = {"memcpyopt", "NumMoveToCpy" , "Number of memmoves converted to memcpy"}; | ||||||||||||||
| 77 | STATISTIC(NumCpyToSet, "Number of memcpys converted to memset")static llvm::Statistic NumCpyToSet = {"memcpyopt", "NumCpyToSet" , "Number of memcpys converted to memset"}; | ||||||||||||||
| 78 | STATISTIC(NumCallSlot, "Number of call slot optimizations performed")static llvm::Statistic NumCallSlot = {"memcpyopt", "NumCallSlot" , "Number of call slot optimizations performed"}; | ||||||||||||||
| 79 | |||||||||||||||
| 80 | namespace { | ||||||||||||||
| 81 | |||||||||||||||
| 82 | /// Represents a range of memset'd bytes with the ByteVal value. | ||||||||||||||
| 83 | /// This allows us to analyze stores like: | ||||||||||||||
| 84 | /// store 0 -> P+1 | ||||||||||||||
| 85 | /// store 0 -> P+0 | ||||||||||||||
| 86 | /// store 0 -> P+3 | ||||||||||||||
| 87 | /// store 0 -> P+2 | ||||||||||||||
| 88 | /// which sometimes happens with stores to arrays of structs etc. When we see | ||||||||||||||
| 89 | /// the first store, we make a range [1, 2). The second store extends the range | ||||||||||||||
| 90 | /// to [0, 2). The third makes a new range [2, 3). The fourth store joins the | ||||||||||||||
| 91 | /// two ranges into [0, 3) which is memset'able. | ||||||||||||||
| 92 | struct MemsetRange { | ||||||||||||||
| 93 | // Start/End - A semi range that describes the span that this range covers. | ||||||||||||||
| 94 | // The range is closed at the start and open at the end: [Start, End). | ||||||||||||||
| 95 | int64_t Start, End; | ||||||||||||||
| 96 | |||||||||||||||
| 97 | /// StartPtr - The getelementptr instruction that points to the start of the | ||||||||||||||
| 98 | /// range. | ||||||||||||||
| 99 | Value *StartPtr; | ||||||||||||||
| 100 | |||||||||||||||
| 101 | /// Alignment - The known alignment of the first store. | ||||||||||||||
| 102 | unsigned Alignment; | ||||||||||||||
| 103 | |||||||||||||||
| 104 | /// TheStores - The actual stores that make up this range. | ||||||||||||||
| 105 | SmallVector<Instruction*, 16> TheStores; | ||||||||||||||
| 106 | |||||||||||||||
| 107 | bool isProfitableToUseMemset(const DataLayout &DL) const; | ||||||||||||||
| 108 | }; | ||||||||||||||
| 109 | |||||||||||||||
| 110 | } // end anonymous namespace | ||||||||||||||
| 111 | |||||||||||||||
| 112 | bool MemsetRange::isProfitableToUseMemset(const DataLayout &DL) const { | ||||||||||||||
| 113 | // If we found more than 4 stores to merge or 16 bytes, use memset. | ||||||||||||||
| 114 | if (TheStores.size() >= 4 || End-Start >= 16) return true; | ||||||||||||||
| 115 | |||||||||||||||
| 116 | // If there is nothing to merge, don't do anything. | ||||||||||||||
| 117 | if (TheStores.size() < 2) return false; | ||||||||||||||
| 118 | |||||||||||||||
| 119 | // If any of the stores are a memset, then it is always good to extend the | ||||||||||||||
| 120 | // memset. | ||||||||||||||
| 121 | for (Instruction *SI : TheStores) | ||||||||||||||
| 122 | if (!isa<StoreInst>(SI)) | ||||||||||||||
| 123 | return true; | ||||||||||||||
| 124 | |||||||||||||||
| 125 | // Assume that the code generator is capable of merging pairs of stores | ||||||||||||||
| 126 | // together if it wants to. | ||||||||||||||
| 127 | if (TheStores.size() == 2) return false; | ||||||||||||||
| 128 | |||||||||||||||
| 129 | // If we have fewer than 8 stores, it can still be worthwhile to do this. | ||||||||||||||
| 130 | // For example, merging 4 i8 stores into an i32 store is useful almost always. | ||||||||||||||
| 131 | // However, merging 2 32-bit stores isn't useful on a 32-bit architecture (the | ||||||||||||||
| 132 | // memset will be split into 2 32-bit stores anyway) and doing so can | ||||||||||||||
| 133 | // pessimize the llvm optimizer. | ||||||||||||||
| 134 | // | ||||||||||||||
| 135 | // Since we don't have perfect knowledge here, make some assumptions: assume | ||||||||||||||
| 136 | // the maximum GPR width is the same size as the largest legal integer | ||||||||||||||
| 137 | // size. If so, check to see whether we will end up actually reducing the | ||||||||||||||
| 138 | // number of stores used. | ||||||||||||||
| 139 | unsigned Bytes = unsigned(End-Start); | ||||||||||||||
| 140 | unsigned MaxIntSize = DL.getLargestLegalIntTypeSizeInBits() / 8; | ||||||||||||||
| 141 | if (MaxIntSize == 0) | ||||||||||||||
| 142 | MaxIntSize = 1; | ||||||||||||||
| 143 | unsigned NumPointerStores = Bytes / MaxIntSize; | ||||||||||||||
| 144 | |||||||||||||||
| 145 | // Assume the remaining bytes if any are done a byte at a time. | ||||||||||||||
| 146 | unsigned NumByteStores = Bytes % MaxIntSize; | ||||||||||||||
| 147 | |||||||||||||||
| 148 | // If we will reduce the # stores (according to this heuristic), do the | ||||||||||||||
| 149 | // transformation. This encourages merging 4 x i8 -> i32 and 2 x i16 -> i32 | ||||||||||||||
| 150 | // etc. | ||||||||||||||
| 151 | return TheStores.size() > NumPointerStores+NumByteStores; | ||||||||||||||
| 152 | } | ||||||||||||||
| 153 | |||||||||||||||
| 154 | namespace { | ||||||||||||||
| 155 | |||||||||||||||
| 156 | class MemsetRanges { | ||||||||||||||
| 157 | using range_iterator = SmallVectorImpl<MemsetRange>::iterator; | ||||||||||||||
| 158 | |||||||||||||||
| 159 | /// A sorted list of the memset ranges. | ||||||||||||||
| 160 | SmallVector<MemsetRange, 8> Ranges; | ||||||||||||||
| 161 | |||||||||||||||
| 162 | const DataLayout &DL; | ||||||||||||||
| 163 | |||||||||||||||
| 164 | public: | ||||||||||||||
| 165 | MemsetRanges(const DataLayout &DL) : DL(DL) {} | ||||||||||||||
| 166 | |||||||||||||||
| 167 | using const_iterator = SmallVectorImpl<MemsetRange>::const_iterator; | ||||||||||||||
| 168 | |||||||||||||||
| 169 | const_iterator begin() const { return Ranges.begin(); } | ||||||||||||||
| 170 | const_iterator end() const { return Ranges.end(); } | ||||||||||||||
| 171 | bool empty() const { return Ranges.empty(); } | ||||||||||||||
| 172 | |||||||||||||||
| 173 | void addInst(int64_t OffsetFromFirst, Instruction *Inst) { | ||||||||||||||
| 174 | if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) | ||||||||||||||
| 175 | addStore(OffsetFromFirst, SI); | ||||||||||||||
| 176 | else | ||||||||||||||
| 177 | addMemSet(OffsetFromFirst, cast<MemSetInst>(Inst)); | ||||||||||||||
| 178 | } | ||||||||||||||
| 179 | |||||||||||||||
| 180 | void addStore(int64_t OffsetFromFirst, StoreInst *SI) { | ||||||||||||||
| 181 | TypeSize StoreSize = DL.getTypeStoreSize(SI->getOperand(0)->getType()); | ||||||||||||||
| 182 | assert(!StoreSize.isScalable() && "Can't track scalable-typed stores")((void)0); | ||||||||||||||
| 183 | addRange(OffsetFromFirst, StoreSize.getFixedSize(), SI->getPointerOperand(), | ||||||||||||||
| 184 | SI->getAlign().value(), SI); | ||||||||||||||
| 185 | } | ||||||||||||||
| 186 | |||||||||||||||
| 187 | void addMemSet(int64_t OffsetFromFirst, MemSetInst *MSI) { | ||||||||||||||
| 188 | int64_t Size = cast<ConstantInt>(MSI->getLength())->getZExtValue(); | ||||||||||||||
| 189 | addRange(OffsetFromFirst, Size, MSI->getDest(), MSI->getDestAlignment(), MSI); | ||||||||||||||
| 190 | } | ||||||||||||||
| 191 | |||||||||||||||
| 192 | void addRange(int64_t Start, int64_t Size, Value *Ptr, | ||||||||||||||
| 193 | unsigned Alignment, Instruction *Inst); | ||||||||||||||
| 194 | }; | ||||||||||||||
| 195 | |||||||||||||||
| 196 | } // end anonymous namespace | ||||||||||||||
| 197 | |||||||||||||||
| 198 | /// Add a new store to the MemsetRanges data structure. This adds a | ||||||||||||||
| 199 | /// new range for the specified store at the specified offset, merging into | ||||||||||||||
| 200 | /// existing ranges as appropriate. | ||||||||||||||
| 201 | void MemsetRanges::addRange(int64_t Start, int64_t Size, Value *Ptr, | ||||||||||||||
| 202 | unsigned Alignment, Instruction *Inst) { | ||||||||||||||
| 203 | int64_t End = Start+Size; | ||||||||||||||
| 204 | |||||||||||||||
| 205 | range_iterator I = partition_point( | ||||||||||||||
| 206 | Ranges, [=](const MemsetRange &O) { return O.End < Start; }); | ||||||||||||||
| 207 | |||||||||||||||
| 208 | // We now know that I == E, in which case we didn't find anything to merge | ||||||||||||||
| 209 | // with, or that Start <= I->End. If End < I->Start or I == E, then we need | ||||||||||||||
| 210 | // to insert a new range. Handle this now. | ||||||||||||||
| 211 | if (I == Ranges.end() || End < I->Start) { | ||||||||||||||
| 212 | MemsetRange &R = *Ranges.insert(I, MemsetRange()); | ||||||||||||||
| 213 | R.Start = Start; | ||||||||||||||
| 214 | R.End = End; | ||||||||||||||
| 215 | R.StartPtr = Ptr; | ||||||||||||||
| 216 | R.Alignment = Alignment; | ||||||||||||||
| 217 | R.TheStores.push_back(Inst); | ||||||||||||||
| 218 | return; | ||||||||||||||
| 219 | } | ||||||||||||||
| 220 | |||||||||||||||
| 221 | // This store overlaps with I, add it. | ||||||||||||||
| 222 | I->TheStores.push_back(Inst); | ||||||||||||||
| 223 | |||||||||||||||
| 224 | // At this point, we may have an interval that completely contains our store. | ||||||||||||||
| 225 | // If so, just add it to the interval and return. | ||||||||||||||
| 226 | if (I->Start <= Start && I->End >= End) | ||||||||||||||
| 227 | return; | ||||||||||||||
| 228 | |||||||||||||||
| 229 | // Now we know that Start <= I->End and End >= I->Start so the range overlaps | ||||||||||||||
| 230 | // but is not entirely contained within the range. | ||||||||||||||
| 231 | |||||||||||||||
| 232 | // See if the range extends the start of the range. In this case, it couldn't | ||||||||||||||
| 233 | // possibly cause it to join the prior range, because otherwise we would have | ||||||||||||||
| 234 | // stopped on *it*. | ||||||||||||||
| 235 | if (Start < I->Start) { | ||||||||||||||
| 236 | I->Start = Start; | ||||||||||||||
| 237 | I->StartPtr = Ptr; | ||||||||||||||
| 238 | I->Alignment = Alignment; | ||||||||||||||
| 239 | } | ||||||||||||||
| 240 | |||||||||||||||
| 241 | // Now we know that Start <= I->End and Start >= I->Start (so the startpoint | ||||||||||||||
| 242 | // is in or right at the end of I), and that End >= I->Start. Extend I out to | ||||||||||||||
| 243 | // End. | ||||||||||||||
| 244 | if (End > I->End) { | ||||||||||||||
| 245 | I->End = End; | ||||||||||||||
| 246 | range_iterator NextI = I; | ||||||||||||||
| 247 | while (++NextI != Ranges.end() && End >= NextI->Start) { | ||||||||||||||
| 248 | // Merge the range in. | ||||||||||||||
| 249 | I->TheStores.append(NextI->TheStores.begin(), NextI->TheStores.end()); | ||||||||||||||
| 250 | if (NextI->End > I->End) | ||||||||||||||
| 251 | I->End = NextI->End; | ||||||||||||||
| 252 | Ranges.erase(NextI); | ||||||||||||||
| 253 | NextI = I; | ||||||||||||||
| 254 | } | ||||||||||||||
| 255 | } | ||||||||||||||
| 256 | } | ||||||||||||||
| 257 | |||||||||||||||
| 258 | //===----------------------------------------------------------------------===// | ||||||||||||||
| 259 | // MemCpyOptLegacyPass Pass | ||||||||||||||
| 260 | //===----------------------------------------------------------------------===// | ||||||||||||||
| 261 | |||||||||||||||
| 262 | namespace { | ||||||||||||||
| 263 | |||||||||||||||
| 264 | class MemCpyOptLegacyPass : public FunctionPass { | ||||||||||||||
| 265 | MemCpyOptPass Impl; | ||||||||||||||
| 266 | |||||||||||||||
| 267 | public: | ||||||||||||||
| 268 | static char ID; // Pass identification, replacement for typeid | ||||||||||||||
| 269 | |||||||||||||||
| 270 | MemCpyOptLegacyPass() : FunctionPass(ID) { | ||||||||||||||
| 271 | initializeMemCpyOptLegacyPassPass(*PassRegistry::getPassRegistry()); | ||||||||||||||
| 272 | } | ||||||||||||||
| 273 | |||||||||||||||
| 274 | bool runOnFunction(Function &F) override; | ||||||||||||||
| 275 | |||||||||||||||
| 276 | private: | ||||||||||||||
| 277 | // This transformation requires dominator postdominator info | ||||||||||||||
| 278 | void getAnalysisUsage(AnalysisUsage &AU) const override { | ||||||||||||||
| 279 | AU.setPreservesCFG(); | ||||||||||||||
| 280 | AU.addRequired<AssumptionCacheTracker>(); | ||||||||||||||
| 281 | AU.addRequired<DominatorTreeWrapperPass>(); | ||||||||||||||
| 282 | AU.addPreserved<DominatorTreeWrapperPass>(); | ||||||||||||||
| 283 | AU.addPreserved<GlobalsAAWrapperPass>(); | ||||||||||||||
| 284 | AU.addRequired<TargetLibraryInfoWrapperPass>(); | ||||||||||||||
| 285 | if (!EnableMemorySSA) | ||||||||||||||
| 286 | AU.addRequired<MemoryDependenceWrapperPass>(); | ||||||||||||||
| 287 | AU.addPreserved<MemoryDependenceWrapperPass>(); | ||||||||||||||
| 288 | AU.addRequired<AAResultsWrapperPass>(); | ||||||||||||||
| 289 | AU.addPreserved<AAResultsWrapperPass>(); | ||||||||||||||
| 290 | if (EnableMemorySSA) | ||||||||||||||
| 291 | AU.addRequired<MemorySSAWrapperPass>(); | ||||||||||||||
| 292 | AU.addPreserved<MemorySSAWrapperPass>(); | ||||||||||||||
| 293 | } | ||||||||||||||
| 294 | }; | ||||||||||||||
| 295 | |||||||||||||||
| 296 | } // end anonymous namespace | ||||||||||||||
| 297 | |||||||||||||||
| 298 | char MemCpyOptLegacyPass::ID = 0; | ||||||||||||||
| 299 | |||||||||||||||
| 300 | /// The public interface to this file... | ||||||||||||||
| 301 | FunctionPass *llvm::createMemCpyOptPass() { return new MemCpyOptLegacyPass(); } | ||||||||||||||
| 302 | |||||||||||||||
| 303 | INITIALIZE_PASS_BEGIN(MemCpyOptLegacyPass, "memcpyopt", "MemCpy Optimization",static void *initializeMemCpyOptLegacyPassPassOnce(PassRegistry &Registry) { | ||||||||||||||
| 304 | false, false)static void *initializeMemCpyOptLegacyPassPassOnce(PassRegistry &Registry) { | ||||||||||||||
| 305 | INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)initializeAssumptionCacheTrackerPass(Registry); | ||||||||||||||
| 306 | INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)initializeDominatorTreeWrapperPassPass(Registry); | ||||||||||||||
| 307 | INITIALIZE_PASS_DEPENDENCY(MemoryDependenceWrapperPass)initializeMemoryDependenceWrapperPassPass(Registry); | ||||||||||||||
| 308 | INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)initializeTargetLibraryInfoWrapperPassPass(Registry); | ||||||||||||||
| 309 | INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass)initializeAAResultsWrapperPassPass(Registry); | ||||||||||||||
| 310 | INITIALIZE_PASS_DEPENDENCY(GlobalsAAWrapperPass)initializeGlobalsAAWrapperPassPass(Registry); | ||||||||||||||
| 311 | INITIALIZE_PASS_DEPENDENCY(MemorySSAWrapperPass)initializeMemorySSAWrapperPassPass(Registry); | ||||||||||||||
| 312 | INITIALIZE_PASS_END(MemCpyOptLegacyPass, "memcpyopt", "MemCpy Optimization",PassInfo *PI = new PassInfo( "MemCpy Optimization", "memcpyopt" , &MemCpyOptLegacyPass::ID, PassInfo::NormalCtor_t(callDefaultCtor <MemCpyOptLegacyPass>), false, false); Registry.registerPass (*PI, true); return PI; } static llvm::once_flag InitializeMemCpyOptLegacyPassPassFlag ; void llvm::initializeMemCpyOptLegacyPassPass(PassRegistry & Registry) { llvm::call_once(InitializeMemCpyOptLegacyPassPassFlag , initializeMemCpyOptLegacyPassPassOnce, std::ref(Registry)); } | ||||||||||||||
| 313 | false, false)PassInfo *PI = new PassInfo( "MemCpy Optimization", "memcpyopt" , &MemCpyOptLegacyPass::ID, PassInfo::NormalCtor_t(callDefaultCtor <MemCpyOptLegacyPass>), false, false); Registry.registerPass (*PI, true); return PI; } static llvm::once_flag InitializeMemCpyOptLegacyPassPassFlag ; void llvm::initializeMemCpyOptLegacyPassPass(PassRegistry & Registry) { llvm::call_once(InitializeMemCpyOptLegacyPassPassFlag , initializeMemCpyOptLegacyPassPassOnce, std::ref(Registry)); } | ||||||||||||||
| 314 | |||||||||||||||
| 315 | // Check that V is either not accessible by the caller, or unwinding cannot | ||||||||||||||
| 316 | // occur between Start and End. | ||||||||||||||
| 317 | static bool mayBeVisibleThroughUnwinding(Value *V, Instruction *Start, | ||||||||||||||
| 318 | Instruction *End) { | ||||||||||||||
| 319 | assert(Start->getParent() == End->getParent() && "Must be in same block")((void)0); | ||||||||||||||
| 320 | if (!Start->getFunction()->doesNotThrow() && | ||||||||||||||
| 321 | !isa<AllocaInst>(getUnderlyingObject(V))) { | ||||||||||||||
| 322 | for (const Instruction &I : | ||||||||||||||
| 323 | make_range(Start->getIterator(), End->getIterator())) { | ||||||||||||||
| 324 | if (I.mayThrow()) | ||||||||||||||
| 325 | return true; | ||||||||||||||
| 326 | } | ||||||||||||||
| 327 | } | ||||||||||||||
| 328 | return false; | ||||||||||||||
| 329 | } | ||||||||||||||
| 330 | |||||||||||||||
| 331 | void MemCpyOptPass::eraseInstruction(Instruction *I) { | ||||||||||||||
| 332 | if (MSSAU) | ||||||||||||||
| 333 | MSSAU->removeMemoryAccess(I); | ||||||||||||||
| 334 | if (MD) | ||||||||||||||
| 335 | MD->removeInstruction(I); | ||||||||||||||
| 336 | I->eraseFromParent(); | ||||||||||||||
| 337 | } | ||||||||||||||
| 338 | |||||||||||||||
| 339 | // Check for mod or ref of Loc between Start and End, excluding both boundaries. | ||||||||||||||
| 340 | // Start and End must be in the same block | ||||||||||||||
| 341 | static bool accessedBetween(AliasAnalysis &AA, MemoryLocation Loc, | ||||||||||||||
| 342 | const MemoryUseOrDef *Start, | ||||||||||||||
| 343 | const MemoryUseOrDef *End) { | ||||||||||||||
| 344 | assert(Start->getBlock() == End->getBlock() && "Only local supported")((void)0); | ||||||||||||||
| 345 | for (const MemoryAccess &MA : | ||||||||||||||
| 346 | make_range(++Start->getIterator(), End->getIterator())) { | ||||||||||||||
| 347 | if (isModOrRefSet(AA.getModRefInfo(cast<MemoryUseOrDef>(MA).getMemoryInst(), | ||||||||||||||
| 348 | Loc))) | ||||||||||||||
| 349 | return true; | ||||||||||||||
| 350 | } | ||||||||||||||
| 351 | return false; | ||||||||||||||
| 352 | } | ||||||||||||||
| 353 | |||||||||||||||
| 354 | // Check for mod of Loc between Start and End, excluding both boundaries. | ||||||||||||||
| 355 | // Start and End can be in different blocks. | ||||||||||||||
| 356 | static bool writtenBetween(MemorySSA *MSSA, MemoryLocation Loc, | ||||||||||||||
| 357 | const MemoryUseOrDef *Start, | ||||||||||||||
| 358 | const MemoryUseOrDef *End) { | ||||||||||||||
| 359 | // TODO: Only walk until we hit Start. | ||||||||||||||
| 360 | MemoryAccess *Clobber = MSSA->getWalker()->getClobberingMemoryAccess( | ||||||||||||||
| 361 | End->getDefiningAccess(), Loc); | ||||||||||||||
| 362 | return !MSSA->dominates(Clobber, Start); | ||||||||||||||
| 363 | } | ||||||||||||||
| 364 | |||||||||||||||
| 365 | /// When scanning forward over instructions, we look for some other patterns to | ||||||||||||||
| 366 | /// fold away. In particular, this looks for stores to neighboring locations of | ||||||||||||||
| 367 | /// memory. If it sees enough consecutive ones, it attempts to merge them | ||||||||||||||
| 368 | /// together into a memcpy/memset. | ||||||||||||||
| 369 | Instruction *MemCpyOptPass::tryMergingIntoMemset(Instruction *StartInst, | ||||||||||||||
| 370 | Value *StartPtr, | ||||||||||||||
| 371 | Value *ByteVal) { | ||||||||||||||
| 372 | const DataLayout &DL = StartInst->getModule()->getDataLayout(); | ||||||||||||||
| 373 | |||||||||||||||
| 374 | // We can't track scalable types | ||||||||||||||
| 375 | if (StoreInst *SI = dyn_cast<StoreInst>(StartInst)) | ||||||||||||||
| 376 | if (DL.getTypeStoreSize(SI->getOperand(0)->getType()).isScalable()) | ||||||||||||||
| 377 | return nullptr; | ||||||||||||||
| 378 | |||||||||||||||
| 379 | // Okay, so we now have a single store that can be splatable. Scan to find | ||||||||||||||
| 380 | // all subsequent stores of the same value to offset from the same pointer. | ||||||||||||||
| 381 | // Join these together into ranges, so we can decide whether contiguous blocks | ||||||||||||||
| 382 | // are stored. | ||||||||||||||
| 383 | MemsetRanges Ranges(DL); | ||||||||||||||
| 384 | |||||||||||||||
| 385 | BasicBlock::iterator BI(StartInst); | ||||||||||||||
| 386 | |||||||||||||||
| 387 | // Keeps track of the last memory use or def before the insertion point for | ||||||||||||||
| 388 | // the new memset. The new MemoryDef for the inserted memsets will be inserted | ||||||||||||||
| 389 | // after MemInsertPoint. It points to either LastMemDef or to the last user | ||||||||||||||
| 390 | // before the insertion point of the memset, if there are any such users. | ||||||||||||||
| 391 | MemoryUseOrDef *MemInsertPoint = nullptr; | ||||||||||||||
| 392 | // Keeps track of the last MemoryDef between StartInst and the insertion point | ||||||||||||||
| 393 | // for the new memset. This will become the defining access of the inserted | ||||||||||||||
| 394 | // memsets. | ||||||||||||||
| 395 | MemoryDef *LastMemDef = nullptr; | ||||||||||||||
| 396 | for (++BI; !BI->isTerminator(); ++BI) { | ||||||||||||||
| 397 | if (MSSAU) { | ||||||||||||||
| 398 | auto *CurrentAcc = cast_or_null<MemoryUseOrDef>( | ||||||||||||||
| 399 | MSSAU->getMemorySSA()->getMemoryAccess(&*BI)); | ||||||||||||||
| 400 | if (CurrentAcc) { | ||||||||||||||
| 401 | MemInsertPoint = CurrentAcc; | ||||||||||||||
| 402 | if (auto *CurrentDef = dyn_cast<MemoryDef>(CurrentAcc)) | ||||||||||||||
| 403 | LastMemDef = CurrentDef; | ||||||||||||||
| 404 | } | ||||||||||||||
| 405 | } | ||||||||||||||
| 406 | |||||||||||||||
| 407 | // Calls that only access inaccessible memory do not block merging | ||||||||||||||
| 408 | // accessible stores. | ||||||||||||||
| 409 | if (auto *CB = dyn_cast<CallBase>(BI)) { | ||||||||||||||
| 410 | if (CB->onlyAccessesInaccessibleMemory()) | ||||||||||||||
| 411 | continue; | ||||||||||||||
| 412 | } | ||||||||||||||
| 413 | |||||||||||||||
| 414 | if (!isa<StoreInst>(BI) && !isa<MemSetInst>(BI)) { | ||||||||||||||
| 415 | // If the instruction is readnone, ignore it, otherwise bail out. We | ||||||||||||||
| 416 | // don't even allow readonly here because we don't want something like: | ||||||||||||||
| 417 | // A[1] = 2; strlen(A); A[2] = 2; -> memcpy(A, ...); strlen(A). | ||||||||||||||
| 418 | if (BI->mayWriteToMemory() || BI->mayReadFromMemory()) | ||||||||||||||
| 419 | break; | ||||||||||||||
| 420 | continue; | ||||||||||||||
| 421 | } | ||||||||||||||
| 422 | |||||||||||||||
| 423 | if (StoreInst *NextStore = dyn_cast<StoreInst>(BI)) { | ||||||||||||||
| 424 | // If this is a store, see if we can merge it in. | ||||||||||||||
| 425 | if (!NextStore->isSimple()) break; | ||||||||||||||
| 426 | |||||||||||||||
| 427 | Value *StoredVal = NextStore->getValueOperand(); | ||||||||||||||
| 428 | |||||||||||||||
| 429 | // Don't convert stores of non-integral pointer types to memsets (which | ||||||||||||||
| 430 | // stores integers). | ||||||||||||||
| 431 | if (DL.isNonIntegralPointerType(StoredVal->getType()->getScalarType())) | ||||||||||||||
| 432 | break; | ||||||||||||||
| 433 | |||||||||||||||
| 434 | // We can't track ranges involving scalable types. | ||||||||||||||
| 435 | if (DL.getTypeStoreSize(StoredVal->getType()).isScalable()) | ||||||||||||||
| 436 | break; | ||||||||||||||
| 437 | |||||||||||||||
| 438 | // Check to see if this stored value is of the same byte-splattable value. | ||||||||||||||
| 439 | Value *StoredByte = isBytewiseValue(StoredVal, DL); | ||||||||||||||
| 440 | if (isa<UndefValue>(ByteVal) && StoredByte) | ||||||||||||||
| 441 | ByteVal = StoredByte; | ||||||||||||||
| 442 | if (ByteVal != StoredByte) | ||||||||||||||
| 443 | break; | ||||||||||||||
| 444 | |||||||||||||||
| 445 | // Check to see if this store is to a constant offset from the start ptr. | ||||||||||||||
| 446 | Optional<int64_t> Offset = | ||||||||||||||
| 447 | isPointerOffset(StartPtr, NextStore->getPointerOperand(), DL); | ||||||||||||||
| 448 | if (!Offset) | ||||||||||||||
| 449 | break; | ||||||||||||||
| 450 | |||||||||||||||
| 451 | Ranges.addStore(*Offset, NextStore); | ||||||||||||||
| 452 | } else { | ||||||||||||||
| 453 | MemSetInst *MSI = cast<MemSetInst>(BI); | ||||||||||||||
| 454 | |||||||||||||||
| 455 | if (MSI->isVolatile() || ByteVal != MSI->getValue() || | ||||||||||||||
| 456 | !isa<ConstantInt>(MSI->getLength())) | ||||||||||||||
| 457 | break; | ||||||||||||||
| 458 | |||||||||||||||
| 459 | // Check to see if this store is to a constant offset from the start ptr. | ||||||||||||||
| 460 | Optional<int64_t> Offset = isPointerOffset(StartPtr, MSI->getDest(), DL); | ||||||||||||||
| 461 | if (!Offset) | ||||||||||||||
| 462 | break; | ||||||||||||||
| 463 | |||||||||||||||
| 464 | Ranges.addMemSet(*Offset, MSI); | ||||||||||||||
| 465 | } | ||||||||||||||
| 466 | } | ||||||||||||||
| 467 | |||||||||||||||
| 468 | // If we have no ranges, then we just had a single store with nothing that | ||||||||||||||
| 469 | // could be merged in. This is a very common case of course. | ||||||||||||||
| 470 | if (Ranges.empty()) | ||||||||||||||
| 471 | return nullptr; | ||||||||||||||
| 472 | |||||||||||||||
| 473 | // If we had at least one store that could be merged in, add the starting | ||||||||||||||
| 474 | // store as well. We try to avoid this unless there is at least something | ||||||||||||||
| 475 | // interesting as a small compile-time optimization. | ||||||||||||||
| 476 | Ranges.addInst(0, StartInst); | ||||||||||||||
| 477 | |||||||||||||||
| 478 | // If we create any memsets, we put it right before the first instruction that | ||||||||||||||
| 479 | // isn't part of the memset block. This ensure that the memset is dominated | ||||||||||||||
| 480 | // by any addressing instruction needed by the start of the block. | ||||||||||||||
| 481 | IRBuilder<> Builder(&*BI); | ||||||||||||||
| 482 | |||||||||||||||
| 483 | // Now that we have full information about ranges, loop over the ranges and | ||||||||||||||
| 484 | // emit memset's for anything big enough to be worthwhile. | ||||||||||||||
| 485 | Instruction *AMemSet = nullptr; | ||||||||||||||
| 486 | for (const MemsetRange &Range : Ranges) { | ||||||||||||||
| 487 | if (Range.TheStores.size() == 1) continue; | ||||||||||||||
| 488 | |||||||||||||||
| 489 | // If it is profitable to lower this range to memset, do so now. | ||||||||||||||
| 490 | if (!Range.isProfitableToUseMemset(DL)) | ||||||||||||||
| 491 | continue; | ||||||||||||||
| 492 | |||||||||||||||
| 493 | // Otherwise, we do want to transform this! Create a new memset. | ||||||||||||||
| 494 | // Get the starting pointer of the block. | ||||||||||||||
| 495 | StartPtr = Range.StartPtr; | ||||||||||||||
| 496 | |||||||||||||||
| 497 | AMemSet = Builder.CreateMemSet(StartPtr, ByteVal, Range.End - Range.Start, | ||||||||||||||
| 498 | MaybeAlign(Range.Alignment)); | ||||||||||||||
| 499 | LLVM_DEBUG(dbgs() << "Replace stores:\n"; for (Instruction *SIdo { } while (false) | ||||||||||||||
| 500 | : Range.TheStores) dbgs()do { } while (false) | ||||||||||||||
| 501 | << *SI << '\n';do { } while (false) | ||||||||||||||
| 502 | dbgs() << "With: " << *AMemSet << '\n')do { } while (false); | ||||||||||||||
| 503 | if (!Range.TheStores.empty()) | ||||||||||||||
| 504 | AMemSet->setDebugLoc(Range.TheStores[0]->getDebugLoc()); | ||||||||||||||
| 505 | |||||||||||||||
| 506 | if (MSSAU) { | ||||||||||||||
| 507 | assert(LastMemDef && MemInsertPoint &&((void)0) | ||||||||||||||
| 508 | "Both LastMemDef and MemInsertPoint need to be set")((void)0); | ||||||||||||||
| 509 | auto *NewDef = | ||||||||||||||
| 510 | cast<MemoryDef>(MemInsertPoint->getMemoryInst() == &*BI | ||||||||||||||
| 511 | ? MSSAU->createMemoryAccessBefore( | ||||||||||||||
| 512 | AMemSet, LastMemDef, MemInsertPoint) | ||||||||||||||
| 513 | : MSSAU->createMemoryAccessAfter( | ||||||||||||||
| 514 | AMemSet, LastMemDef, MemInsertPoint)); | ||||||||||||||
| 515 | MSSAU->insertDef(NewDef, /*RenameUses=*/true); | ||||||||||||||
| 516 | LastMemDef = NewDef; | ||||||||||||||
| 517 | MemInsertPoint = NewDef; | ||||||||||||||
| 518 | } | ||||||||||||||
| 519 | |||||||||||||||
| 520 | // Zap all the stores. | ||||||||||||||
| 521 | for (Instruction *SI : Range.TheStores) | ||||||||||||||
| 522 | eraseInstruction(SI); | ||||||||||||||
| 523 | |||||||||||||||
| 524 | ++NumMemSetInfer; | ||||||||||||||
| 525 | } | ||||||||||||||
| 526 | |||||||||||||||
| 527 | return AMemSet; | ||||||||||||||
| 528 | } | ||||||||||||||
| 529 | |||||||||||||||
| 530 | // This method try to lift a store instruction before position P. | ||||||||||||||
| 531 | // It will lift the store and its argument + that anything that | ||||||||||||||
| 532 | // may alias with these. | ||||||||||||||
| 533 | // The method returns true if it was successful. | ||||||||||||||
| 534 | bool MemCpyOptPass::moveUp(StoreInst *SI, Instruction *P, const LoadInst *LI) { | ||||||||||||||
| 535 | // If the store alias this position, early bail out. | ||||||||||||||
| 536 | MemoryLocation StoreLoc = MemoryLocation::get(SI); | ||||||||||||||
| 537 | if (isModOrRefSet(AA->getModRefInfo(P, StoreLoc))) | ||||||||||||||
| 538 | return false; | ||||||||||||||
| 539 | |||||||||||||||
| 540 | // Keep track of the arguments of all instruction we plan to lift | ||||||||||||||
| 541 | // so we can make sure to lift them as well if appropriate. | ||||||||||||||
| 542 | DenseSet<Instruction*> Args; | ||||||||||||||
| 543 | if (auto *Ptr = dyn_cast<Instruction>(SI->getPointerOperand())) | ||||||||||||||
| 544 | if (Ptr->getParent() == SI->getParent()) | ||||||||||||||
| 545 | Args.insert(Ptr); | ||||||||||||||
| 546 | |||||||||||||||
| 547 | // Instruction to lift before P. | ||||||||||||||
| 548 | SmallVector<Instruction *, 8> ToLift{SI}; | ||||||||||||||
| 549 | |||||||||||||||
| 550 | // Memory locations of lifted instructions. | ||||||||||||||
| 551 | SmallVector<MemoryLocation, 8> MemLocs{StoreLoc}; | ||||||||||||||
| 552 | |||||||||||||||
| 553 | // Lifted calls. | ||||||||||||||
| 554 | SmallVector<const CallBase *, 8> Calls; | ||||||||||||||
| 555 | |||||||||||||||
| 556 | const MemoryLocation LoadLoc = MemoryLocation::get(LI); | ||||||||||||||
| 557 | |||||||||||||||
| 558 | for (auto I = --SI->getIterator(), E = P->getIterator(); I != E; --I) { | ||||||||||||||
| 559 | auto *C = &*I; | ||||||||||||||
| 560 | |||||||||||||||
| 561 | // Make sure hoisting does not perform a store that was not guaranteed to | ||||||||||||||
| 562 | // happen. | ||||||||||||||
| 563 | if (!isGuaranteedToTransferExecutionToSuccessor(C)) | ||||||||||||||
| 564 | return false; | ||||||||||||||
| 565 | |||||||||||||||
| 566 | bool MayAlias = isModOrRefSet(AA->getModRefInfo(C, None)); | ||||||||||||||
| 567 | |||||||||||||||
| 568 | bool NeedLift = false; | ||||||||||||||
| 569 | if (Args.erase(C)) | ||||||||||||||
| 570 | NeedLift = true; | ||||||||||||||
| 571 | else if (MayAlias) { | ||||||||||||||
| 572 | NeedLift = llvm::any_of(MemLocs, [C, this](const MemoryLocation &ML) { | ||||||||||||||
| 573 | return isModOrRefSet(AA->getModRefInfo(C, ML)); | ||||||||||||||
| 574 | }); | ||||||||||||||
| 575 | |||||||||||||||
| 576 | if (!NeedLift) | ||||||||||||||
| 577 | NeedLift = llvm::any_of(Calls, [C, this](const CallBase *Call) { | ||||||||||||||
| 578 | return isModOrRefSet(AA->getModRefInfo(C, Call)); | ||||||||||||||
| 579 | }); | ||||||||||||||
| 580 | } | ||||||||||||||
| 581 | |||||||||||||||
| 582 | if (!NeedLift) | ||||||||||||||
| 583 | continue; | ||||||||||||||
| 584 | |||||||||||||||
| 585 | if (MayAlias) { | ||||||||||||||
| 586 | // Since LI is implicitly moved downwards past the lifted instructions, | ||||||||||||||
| 587 | // none of them may modify its source. | ||||||||||||||
| 588 | if (isModSet(AA->getModRefInfo(C, LoadLoc))) | ||||||||||||||
| 589 | return false; | ||||||||||||||
| 590 | else if (const auto *Call = dyn_cast<CallBase>(C)) { | ||||||||||||||
| 591 | // If we can't lift this before P, it's game over. | ||||||||||||||
| 592 | if (isModOrRefSet(AA->getModRefInfo(P, Call))) | ||||||||||||||
| 593 | return false; | ||||||||||||||
| 594 | |||||||||||||||
| 595 | Calls.push_back(Call); | ||||||||||||||
| 596 | } else if (isa<LoadInst>(C) || isa<StoreInst>(C) || isa<VAArgInst>(C)) { | ||||||||||||||
| 597 | // If we can't lift this before P, it's game over. | ||||||||||||||
| 598 | auto ML = MemoryLocation::get(C); | ||||||||||||||
| 599 | if (isModOrRefSet(AA->getModRefInfo(P, ML))) | ||||||||||||||
| 600 | return false; | ||||||||||||||
| 601 | |||||||||||||||
| 602 | MemLocs.push_back(ML); | ||||||||||||||
| 603 | } else | ||||||||||||||
| 604 | // We don't know how to lift this instruction. | ||||||||||||||
| 605 | return false; | ||||||||||||||
| 606 | } | ||||||||||||||
| 607 | |||||||||||||||
| 608 | ToLift.push_back(C); | ||||||||||||||
| 609 | for (unsigned k = 0, e = C->getNumOperands(); k != e; ++k) | ||||||||||||||
| 610 | if (auto *A = dyn_cast<Instruction>(C->getOperand(k))) { | ||||||||||||||
| 611 | if (A->getParent() == SI->getParent()) { | ||||||||||||||
| 612 | // Cannot hoist user of P above P | ||||||||||||||
| 613 | if(A == P) return false; | ||||||||||||||
| 614 | Args.insert(A); | ||||||||||||||
| 615 | } | ||||||||||||||
| 616 | } | ||||||||||||||
| 617 | } | ||||||||||||||
| 618 | |||||||||||||||
| 619 | // Find MSSA insertion point. Normally P will always have a corresponding | ||||||||||||||
| 620 | // memory access before which we can insert. However, with non-standard AA | ||||||||||||||
| 621 | // pipelines, there may be a mismatch between AA and MSSA, in which case we | ||||||||||||||
| 622 | // will scan for a memory access before P. In either case, we know for sure | ||||||||||||||
| 623 | // that at least the load will have a memory access. | ||||||||||||||
| 624 | // TODO: Simplify this once P will be determined by MSSA, in which case the | ||||||||||||||
| 625 | // discrepancy can no longer occur. | ||||||||||||||
| 626 | MemoryUseOrDef *MemInsertPoint = nullptr; | ||||||||||||||
| 627 | if (MSSAU) { | ||||||||||||||
| 628 | if (MemoryUseOrDef *MA = MSSAU->getMemorySSA()->getMemoryAccess(P)) { | ||||||||||||||
| 629 | MemInsertPoint = cast<MemoryUseOrDef>(--MA->getIterator()); | ||||||||||||||
| 630 | } else { | ||||||||||||||
| 631 | const Instruction *ConstP = P; | ||||||||||||||
| 632 | for (const Instruction &I : make_range(++ConstP->getReverseIterator(), | ||||||||||||||
| 633 | ++LI->getReverseIterator())) { | ||||||||||||||
| 634 | if (MemoryUseOrDef *MA = MSSAU->getMemorySSA()->getMemoryAccess(&I)) { | ||||||||||||||
| 635 | MemInsertPoint = MA; | ||||||||||||||
| 636 | break; | ||||||||||||||
| 637 | } | ||||||||||||||
| 638 | } | ||||||||||||||
| 639 | } | ||||||||||||||
| 640 | } | ||||||||||||||
| 641 | |||||||||||||||
| 642 | // We made it, we need to lift. | ||||||||||||||
| 643 | for (auto *I : llvm::reverse(ToLift)) { | ||||||||||||||
| 644 | LLVM_DEBUG(dbgs() << "Lifting " << *I << " before " << *P << "\n")do { } while (false); | ||||||||||||||
| 645 | I->moveBefore(P); | ||||||||||||||
| 646 | if (MSSAU) { | ||||||||||||||
| 647 | assert(MemInsertPoint && "Must have found insert point")((void)0); | ||||||||||||||
| 648 | if (MemoryUseOrDef *MA = MSSAU->getMemorySSA()->getMemoryAccess(I)) { | ||||||||||||||
| 649 | MSSAU->moveAfter(MA, MemInsertPoint); | ||||||||||||||
| 650 | MemInsertPoint = MA; | ||||||||||||||
| 651 | } | ||||||||||||||
| 652 | } | ||||||||||||||
| 653 | } | ||||||||||||||
| 654 | |||||||||||||||
| 655 | return true; | ||||||||||||||
| 656 | } | ||||||||||||||
| 657 | |||||||||||||||
| 658 | bool MemCpyOptPass::processStore(StoreInst *SI, BasicBlock::iterator &BBI) { | ||||||||||||||
| 659 | if (!SI->isSimple()) return false; | ||||||||||||||
| 660 | |||||||||||||||
| 661 | // Avoid merging nontemporal stores since the resulting | ||||||||||||||
| 662 | // memcpy/memset would not be able to preserve the nontemporal hint. | ||||||||||||||
| 663 | // In theory we could teach how to propagate the !nontemporal metadata to | ||||||||||||||
| 664 | // memset calls. However, that change would force the backend to | ||||||||||||||
| 665 | // conservatively expand !nontemporal memset calls back to sequences of | ||||||||||||||
| 666 | // store instructions (effectively undoing the merging). | ||||||||||||||
| 667 | if (SI->getMetadata(LLVMContext::MD_nontemporal)) | ||||||||||||||
| 668 | return false; | ||||||||||||||
| 669 | |||||||||||||||
| 670 | const DataLayout &DL = SI->getModule()->getDataLayout(); | ||||||||||||||
| 671 | |||||||||||||||
| 672 | Value *StoredVal = SI->getValueOperand(); | ||||||||||||||
| 673 | |||||||||||||||
| 674 | // Not all the transforms below are correct for non-integral pointers, bail | ||||||||||||||
| 675 | // until we've audited the individual pieces. | ||||||||||||||
| 676 | if (DL.isNonIntegralPointerType(StoredVal->getType()->getScalarType())) | ||||||||||||||
| 677 | return false; | ||||||||||||||
| 678 | |||||||||||||||
| 679 | // Load to store forwarding can be interpreted as memcpy. | ||||||||||||||
| 680 | if (LoadInst *LI
| ||||||||||||||
| 681 | if (LI->isSimple() && LI->hasOneUse() && | ||||||||||||||
| 682 | LI->getParent() == SI->getParent()) { | ||||||||||||||
| 683 | |||||||||||||||
| 684 | auto *T = LI->getType(); | ||||||||||||||
| 685 | if (T->isAggregateType()) { | ||||||||||||||
| 686 | MemoryLocation LoadLoc = MemoryLocation::get(LI); | ||||||||||||||
| 687 | |||||||||||||||
| 688 | // We use alias analysis to check if an instruction may store to | ||||||||||||||
| 689 | // the memory we load from in between the load and the store. If | ||||||||||||||
| 690 | // such an instruction is found, we try to promote there instead | ||||||||||||||
| 691 | // of at the store position. | ||||||||||||||
| 692 | // TODO: Can use MSSA for this. | ||||||||||||||
| 693 | Instruction *P = SI; | ||||||||||||||
| 694 | for (auto &I : make_range(++LI->getIterator(), SI->getIterator())) { | ||||||||||||||
| 695 | if (isModSet(AA->getModRefInfo(&I, LoadLoc))) { | ||||||||||||||
| 696 | P = &I; | ||||||||||||||
| 697 | break; | ||||||||||||||
| 698 | } | ||||||||||||||
| 699 | } | ||||||||||||||
| 700 | |||||||||||||||
| 701 | // We found an instruction that may write to the loaded memory. | ||||||||||||||
| 702 | // We can try to promote at this position instead of the store | ||||||||||||||
| 703 | // position if nothing aliases the store memory after this and the store | ||||||||||||||
| 704 | // destination is not in the range. | ||||||||||||||
| 705 | if (P && P != SI) { | ||||||||||||||
| 706 | if (!moveUp(SI, P, LI)) | ||||||||||||||
| 707 | P = nullptr; | ||||||||||||||
| 708 | } | ||||||||||||||
| 709 | |||||||||||||||
| 710 | // If a valid insertion position is found, then we can promote | ||||||||||||||
| 711 | // the load/store pair to a memcpy. | ||||||||||||||
| 712 | if (P) { | ||||||||||||||
| 713 | // If we load from memory that may alias the memory we store to, | ||||||||||||||
| 714 | // memmove must be used to preserve semantic. If not, memcpy can | ||||||||||||||
| 715 | // be used. | ||||||||||||||
| 716 | bool UseMemMove = false; | ||||||||||||||
| 717 | if (!AA->isNoAlias(MemoryLocation::get(SI), LoadLoc)) | ||||||||||||||
| 718 | UseMemMove = true; | ||||||||||||||
| 719 | |||||||||||||||
| 720 | uint64_t Size = DL.getTypeStoreSize(T); | ||||||||||||||
| 721 | |||||||||||||||
| 722 | IRBuilder<> Builder(P); | ||||||||||||||
| 723 | Instruction *M; | ||||||||||||||
| 724 | if (UseMemMove) | ||||||||||||||
| 725 | M = Builder.CreateMemMove( | ||||||||||||||
| 726 | SI->getPointerOperand(), SI->getAlign(), | ||||||||||||||
| 727 | LI->getPointerOperand(), LI->getAlign(), Size); | ||||||||||||||
| 728 | else | ||||||||||||||
| 729 | M = Builder.CreateMemCpy( | ||||||||||||||
| 730 | SI->getPointerOperand(), SI->getAlign(), | ||||||||||||||
| 731 | LI->getPointerOperand(), LI->getAlign(), Size); | ||||||||||||||
| 732 | |||||||||||||||
| 733 | LLVM_DEBUG(dbgs() << "Promoting " << *LI << " to " << *SI << " => "do { } while (false) | ||||||||||||||
| 734 | << *M << "\n")do { } while (false); | ||||||||||||||
| 735 | |||||||||||||||
| 736 | if (MSSAU) { | ||||||||||||||
| 737 | auto *LastDef = | ||||||||||||||
| 738 | cast<MemoryDef>(MSSAU->getMemorySSA()->getMemoryAccess(SI)); | ||||||||||||||
| 739 | auto *NewAccess = | ||||||||||||||
| 740 | MSSAU->createMemoryAccessAfter(M, LastDef, LastDef); | ||||||||||||||
| 741 | MSSAU->insertDef(cast<MemoryDef>(NewAccess), /*RenameUses=*/true); | ||||||||||||||
| 742 | } | ||||||||||||||
| 743 | |||||||||||||||
| 744 | eraseInstruction(SI); | ||||||||||||||
| 745 | eraseInstruction(LI); | ||||||||||||||
| 746 | ++NumMemCpyInstr; | ||||||||||||||
| 747 | |||||||||||||||
| 748 | // Make sure we do not invalidate the iterator. | ||||||||||||||
| 749 | BBI = M->getIterator(); | ||||||||||||||
| 750 | return true; | ||||||||||||||
| 751 | } | ||||||||||||||
| 752 | } | ||||||||||||||
| 753 | |||||||||||||||
| 754 | // Detect cases where we're performing call slot forwarding, but | ||||||||||||||
| 755 | // happen to be using a load-store pair to implement it, rather than | ||||||||||||||
| 756 | // a memcpy. | ||||||||||||||
| 757 | CallInst *C = nullptr; | ||||||||||||||
| 758 | if (EnableMemorySSA) { | ||||||||||||||
| 759 | if (auto *LoadClobber = dyn_cast<MemoryUseOrDef>( | ||||||||||||||
| 760 | MSSA->getWalker()->getClobberingMemoryAccess(LI))) { | ||||||||||||||
| 761 | // The load most post-dom the call. Limit to the same block for now. | ||||||||||||||
| 762 | // TODO: Support non-local call-slot optimization? | ||||||||||||||
| 763 | if (LoadClobber->getBlock() == SI->getParent()) | ||||||||||||||
| 764 | C = dyn_cast_or_null<CallInst>(LoadClobber->getMemoryInst()); | ||||||||||||||
| 765 | } | ||||||||||||||
| 766 | } else { | ||||||||||||||
| 767 | MemDepResult ldep = MD->getDependency(LI); | ||||||||||||||
| |||||||||||||||
| 768 | if (ldep.isClobber() && !isa<MemCpyInst>(ldep.getInst())) | ||||||||||||||
| 769 | C = dyn_cast<CallInst>(ldep.getInst()); | ||||||||||||||
| 770 | } | ||||||||||||||
| 771 | |||||||||||||||
| 772 | if (C) { | ||||||||||||||
| 773 | // Check that nothing touches the dest of the "copy" between | ||||||||||||||
| 774 | // the call and the store. | ||||||||||||||
| 775 | MemoryLocation StoreLoc = MemoryLocation::get(SI); | ||||||||||||||
| 776 | if (EnableMemorySSA) { | ||||||||||||||
| 777 | if (accessedBetween(*AA, StoreLoc, MSSA->getMemoryAccess(C), | ||||||||||||||
| 778 | MSSA->getMemoryAccess(SI))) | ||||||||||||||
| 779 | C = nullptr; | ||||||||||||||
| 780 | } else { | ||||||||||||||
| 781 | for (BasicBlock::iterator I = --SI->getIterator(), | ||||||||||||||
| 782 | E = C->getIterator(); | ||||||||||||||
| 783 | I != E; --I) { | ||||||||||||||
| 784 | if (isModOrRefSet(AA->getModRefInfo(&*I, StoreLoc))) { | ||||||||||||||
| 785 | C = nullptr; | ||||||||||||||
| 786 | break; | ||||||||||||||
| 787 | } | ||||||||||||||
| 788 | } | ||||||||||||||
| 789 | } | ||||||||||||||
| 790 | } | ||||||||||||||
| 791 | |||||||||||||||
| 792 | if (C) { | ||||||||||||||
| 793 | bool changed = performCallSlotOptzn( | ||||||||||||||
| 794 | LI, SI, SI->getPointerOperand()->stripPointerCasts(), | ||||||||||||||
| 795 | LI->getPointerOperand()->stripPointerCasts(), | ||||||||||||||
| 796 | DL.getTypeStoreSize(SI->getOperand(0)->getType()), | ||||||||||||||
| 797 | commonAlignment(SI->getAlign(), LI->getAlign()), C); | ||||||||||||||
| 798 | if (changed) { | ||||||||||||||
| 799 | eraseInstruction(SI); | ||||||||||||||
| 800 | eraseInstruction(LI); | ||||||||||||||
| 801 | ++NumMemCpyInstr; | ||||||||||||||
| 802 | return true; | ||||||||||||||
| 803 | } | ||||||||||||||
| 804 | } | ||||||||||||||
| 805 | } | ||||||||||||||
| 806 | } | ||||||||||||||
| 807 | |||||||||||||||
| 808 | // There are two cases that are interesting for this code to handle: memcpy | ||||||||||||||
| 809 | // and memset. Right now we only handle memset. | ||||||||||||||
| 810 | |||||||||||||||
| 811 | // Ensure that the value being stored is something that can be memset'able a | ||||||||||||||
| 812 | // byte at a time like "0" or "-1" or any width, as well as things like | ||||||||||||||
| 813 | // 0xA0A0A0A0 and 0.0. | ||||||||||||||
| 814 | auto *V = SI->getOperand(0); | ||||||||||||||
| 815 | if (Value *ByteVal = isBytewiseValue(V, DL)) { | ||||||||||||||
| 816 | if (Instruction *I = tryMergingIntoMemset(SI, SI->getPointerOperand(), | ||||||||||||||
| 817 | ByteVal)) { | ||||||||||||||
| 818 | BBI = I->getIterator(); // Don't invalidate iterator. | ||||||||||||||
| 819 | return true; | ||||||||||||||
| 820 | } | ||||||||||||||
| 821 | |||||||||||||||
| 822 | // If we have an aggregate, we try to promote it to memset regardless | ||||||||||||||
| 823 | // of opportunity for merging as it can expose optimization opportunities | ||||||||||||||
| 824 | // in subsequent passes. | ||||||||||||||
| 825 | auto *T = V->getType(); | ||||||||||||||
| 826 | if (T->isAggregateType()) { | ||||||||||||||
| 827 | uint64_t Size = DL.getTypeStoreSize(T); | ||||||||||||||
| 828 | IRBuilder<> Builder(SI); | ||||||||||||||
| 829 | auto *M = Builder.CreateMemSet(SI->getPointerOperand(), ByteVal, Size, | ||||||||||||||
| 830 | SI->getAlign()); | ||||||||||||||
| 831 | |||||||||||||||
| 832 | LLVM_DEBUG(dbgs() << "Promoting " << *SI << " to " << *M << "\n")do { } while (false); | ||||||||||||||
| 833 | |||||||||||||||
| 834 | if (MSSAU) { | ||||||||||||||
| 835 | assert(isa<MemoryDef>(MSSAU->getMemorySSA()->getMemoryAccess(SI)))((void)0); | ||||||||||||||
| 836 | auto *LastDef = | ||||||||||||||
| 837 | cast<MemoryDef>(MSSAU->getMemorySSA()->getMemoryAccess(SI)); | ||||||||||||||
| 838 | auto *NewAccess = MSSAU->createMemoryAccessAfter(M, LastDef, LastDef); | ||||||||||||||
| 839 | MSSAU->insertDef(cast<MemoryDef>(NewAccess), /*RenameUses=*/true); | ||||||||||||||
| 840 | } | ||||||||||||||
| 841 | |||||||||||||||
| 842 | eraseInstruction(SI); | ||||||||||||||
| 843 | NumMemSetInfer++; | ||||||||||||||
| 844 | |||||||||||||||
| 845 | // Make sure we do not invalidate the iterator. | ||||||||||||||
| 846 | BBI = M->getIterator(); | ||||||||||||||
| 847 | return true; | ||||||||||||||
| 848 | } | ||||||||||||||
| 849 | } | ||||||||||||||
| 850 | |||||||||||||||
| 851 | return false; | ||||||||||||||
| 852 | } | ||||||||||||||
| 853 | |||||||||||||||
| 854 | bool MemCpyOptPass::processMemSet(MemSetInst *MSI, BasicBlock::iterator &BBI) { | ||||||||||||||
| 855 | // See if there is another memset or store neighboring this memset which | ||||||||||||||
| 856 | // allows us to widen out the memset to do a single larger store. | ||||||||||||||
| 857 | if (isa<ConstantInt>(MSI->getLength()) && !MSI->isVolatile()) | ||||||||||||||
| 858 | if (Instruction *I = tryMergingIntoMemset(MSI, MSI->getDest(), | ||||||||||||||
| 859 | MSI->getValue())) { | ||||||||||||||
| 860 | BBI = I->getIterator(); // Don't invalidate iterator. | ||||||||||||||
| 861 | return true; | ||||||||||||||
| 862 | } | ||||||||||||||
| 863 | return false; | ||||||||||||||
| 864 | } | ||||||||||||||
| 865 | |||||||||||||||
| 866 | /// Takes a memcpy and a call that it depends on, | ||||||||||||||
| 867 | /// and checks for the possibility of a call slot optimization by having | ||||||||||||||
| 868 | /// the call write its result directly into the destination of the memcpy. | ||||||||||||||
| 869 | bool MemCpyOptPass::performCallSlotOptzn(Instruction *cpyLoad, | ||||||||||||||
| 870 | Instruction *cpyStore, Value *cpyDest, | ||||||||||||||
| 871 | Value *cpySrc, TypeSize cpySize, | ||||||||||||||
| 872 | Align cpyAlign, CallInst *C) { | ||||||||||||||
| 873 | // The general transformation to keep in mind is | ||||||||||||||
| 874 | // | ||||||||||||||
| 875 | // call @func(..., src, ...) | ||||||||||||||
| 876 | // memcpy(dest, src, ...) | ||||||||||||||
| 877 | // | ||||||||||||||
| 878 | // -> | ||||||||||||||
| 879 | // | ||||||||||||||
| 880 | // memcpy(dest, src, ...) | ||||||||||||||
| 881 | // call @func(..., dest, ...) | ||||||||||||||
| 882 | // | ||||||||||||||
| 883 | // Since moving the memcpy is technically awkward, we additionally check that | ||||||||||||||
| 884 | // src only holds uninitialized values at the moment of the call, meaning that | ||||||||||||||
| 885 | // the memcpy can be discarded rather than moved. | ||||||||||||||
| 886 | |||||||||||||||
| 887 | // We can't optimize scalable types. | ||||||||||||||
| 888 | if (cpySize.isScalable()) | ||||||||||||||
| 889 | return false; | ||||||||||||||
| 890 | |||||||||||||||
| 891 | // Lifetime marks shouldn't be operated on. | ||||||||||||||
| 892 | if (Function *F = C->getCalledFunction()) | ||||||||||||||
| 893 | if (F->isIntrinsic() && F->getIntrinsicID() == Intrinsic::lifetime_start) | ||||||||||||||
| 894 | return false; | ||||||||||||||
| 895 | |||||||||||||||
| 896 | // Require that src be an alloca. This simplifies the reasoning considerably. | ||||||||||||||
| 897 | AllocaInst *srcAlloca = dyn_cast<AllocaInst>(cpySrc); | ||||||||||||||
| 898 | if (!srcAlloca) | ||||||||||||||
| 899 | return false; | ||||||||||||||
| 900 | |||||||||||||||
| 901 | ConstantInt *srcArraySize = dyn_cast<ConstantInt>(srcAlloca->getArraySize()); | ||||||||||||||
| 902 | if (!srcArraySize) | ||||||||||||||
| 903 | return false; | ||||||||||||||
| 904 | |||||||||||||||
| 905 | const DataLayout &DL = cpyLoad->getModule()->getDataLayout(); | ||||||||||||||
| 906 | uint64_t srcSize = DL.getTypeAllocSize(srcAlloca->getAllocatedType()) * | ||||||||||||||
| 907 | srcArraySize->getZExtValue(); | ||||||||||||||
| 908 | |||||||||||||||
| 909 | if (cpySize < srcSize) | ||||||||||||||
| 910 | return false; | ||||||||||||||
| 911 | |||||||||||||||
| 912 | // Check that accessing the first srcSize bytes of dest will not cause a | ||||||||||||||
| 913 | // trap. Otherwise the transform is invalid since it might cause a trap | ||||||||||||||
| 914 | // to occur earlier than it otherwise would. | ||||||||||||||
| 915 | if (!isDereferenceableAndAlignedPointer(cpyDest, Align(1), APInt(64, cpySize), | ||||||||||||||
| 916 | DL, C, DT)) | ||||||||||||||
| 917 | return false; | ||||||||||||||
| 918 | |||||||||||||||
| 919 | // Make sure that nothing can observe cpyDest being written early. There are | ||||||||||||||
| 920 | // a number of cases to consider: | ||||||||||||||
| 921 | // 1. cpyDest cannot be accessed between C and cpyStore as a precondition of | ||||||||||||||
| 922 | // the transform. | ||||||||||||||
| 923 | // 2. C itself may not access cpyDest (prior to the transform). This is | ||||||||||||||
| 924 | // checked further below. | ||||||||||||||
| 925 | // 3. If cpyDest is accessible to the caller of this function (potentially | ||||||||||||||
| 926 | // captured and not based on an alloca), we need to ensure that we cannot | ||||||||||||||
| 927 | // unwind between C and cpyStore. This is checked here. | ||||||||||||||
| 928 | // 4. If cpyDest is potentially captured, there may be accesses to it from | ||||||||||||||
| 929 | // another thread. In this case, we need to check that cpyStore is | ||||||||||||||
| 930 | // guaranteed to be executed if C is. As it is a non-atomic access, it | ||||||||||||||
| 931 | // renders accesses from other threads undefined. | ||||||||||||||
| 932 | // TODO: This is currently not checked. | ||||||||||||||
| 933 | if (mayBeVisibleThroughUnwinding(cpyDest, C, cpyStore)) | ||||||||||||||
| 934 | return false; | ||||||||||||||
| 935 | |||||||||||||||
| 936 | // Check that dest points to memory that is at least as aligned as src. | ||||||||||||||
| 937 | Align srcAlign = srcAlloca->getAlign(); | ||||||||||||||
| 938 | bool isDestSufficientlyAligned = srcAlign <= cpyAlign; | ||||||||||||||
| 939 | // If dest is not aligned enough and we can't increase its alignment then | ||||||||||||||
| 940 | // bail out. | ||||||||||||||
| 941 | if (!isDestSufficientlyAligned && !isa<AllocaInst>(cpyDest)) | ||||||||||||||
| 942 | return false; | ||||||||||||||
| 943 | |||||||||||||||
| 944 | // Check that src is not accessed except via the call and the memcpy. This | ||||||||||||||
| 945 | // guarantees that it holds only undefined values when passed in (so the final | ||||||||||||||
| 946 | // memcpy can be dropped), that it is not read or written between the call and | ||||||||||||||
| 947 | // the memcpy, and that writing beyond the end of it is undefined. | ||||||||||||||
| 948 | SmallVector<User *, 8> srcUseList(srcAlloca->users()); | ||||||||||||||
| 949 | while (!srcUseList.empty()) { | ||||||||||||||
| 950 | User *U = srcUseList.pop_back_val(); | ||||||||||||||
| 951 | |||||||||||||||
| 952 | if (isa<BitCastInst>(U) || isa<AddrSpaceCastInst>(U)) { | ||||||||||||||
| 953 | append_range(srcUseList, U->users()); | ||||||||||||||
| 954 | continue; | ||||||||||||||
| 955 | } | ||||||||||||||
| 956 | if (GetElementPtrInst *G = dyn_cast<GetElementPtrInst>(U)) { | ||||||||||||||
| 957 | if (!G->hasAllZeroIndices()) | ||||||||||||||
| 958 | return false; | ||||||||||||||
| 959 | |||||||||||||||
| 960 | append_range(srcUseList, U->users()); | ||||||||||||||
| 961 | continue; | ||||||||||||||
| 962 | } | ||||||||||||||
| 963 | if (const IntrinsicInst *IT = dyn_cast<IntrinsicInst>(U)) | ||||||||||||||
| 964 | if (IT->isLifetimeStartOrEnd()) | ||||||||||||||
| 965 | continue; | ||||||||||||||
| 966 | |||||||||||||||
| 967 | if (U != C && U != cpyLoad) | ||||||||||||||
| 968 | return false; | ||||||||||||||
| 969 | } | ||||||||||||||
| 970 | |||||||||||||||
| 971 | // Check that src isn't captured by the called function since the | ||||||||||||||
| 972 | // transformation can cause aliasing issues in that case. | ||||||||||||||
| 973 | for (unsigned ArgI = 0, E = C->arg_size(); ArgI != E; ++ArgI) | ||||||||||||||
| 974 | if (C->getArgOperand(ArgI) == cpySrc && !C->doesNotCapture(ArgI)) | ||||||||||||||
| 975 | return false; | ||||||||||||||
| 976 | |||||||||||||||
| 977 | // Since we're changing the parameter to the callsite, we need to make sure | ||||||||||||||
| 978 | // that what would be the new parameter dominates the callsite. | ||||||||||||||
| 979 | if (!DT->dominates(cpyDest, C)) { | ||||||||||||||
| 980 | // Support moving a constant index GEP before the call. | ||||||||||||||
| 981 | auto *GEP = dyn_cast<GetElementPtrInst>(cpyDest); | ||||||||||||||
| 982 | if (GEP && GEP->hasAllConstantIndices() && | ||||||||||||||
| 983 | DT->dominates(GEP->getPointerOperand(), C)) | ||||||||||||||
| 984 | GEP->moveBefore(C); | ||||||||||||||
| 985 | else | ||||||||||||||
| 986 | return false; | ||||||||||||||
| 987 | } | ||||||||||||||
| 988 | |||||||||||||||
| 989 | // In addition to knowing that the call does not access src in some | ||||||||||||||
| 990 | // unexpected manner, for example via a global, which we deduce from | ||||||||||||||
| 991 | // the use analysis, we also need to know that it does not sneakily | ||||||||||||||
| 992 | // access dest. We rely on AA to figure this out for us. | ||||||||||||||
| 993 | ModRefInfo MR = AA->getModRefInfo(C, cpyDest, LocationSize::precise(srcSize)); | ||||||||||||||
| 994 | // If necessary, perform additional analysis. | ||||||||||||||
| 995 | if (isModOrRefSet(MR)) | ||||||||||||||
| 996 | MR = AA->callCapturesBefore(C, cpyDest, LocationSize::precise(srcSize), DT); | ||||||||||||||
| 997 | if (isModOrRefSet(MR)) | ||||||||||||||
| 998 | return false; | ||||||||||||||
| 999 | |||||||||||||||
| 1000 | // We can't create address space casts here because we don't know if they're | ||||||||||||||
| 1001 | // safe for the target. | ||||||||||||||
| 1002 | if (cpySrc->getType()->getPointerAddressSpace() != | ||||||||||||||
| 1003 | cpyDest->getType()->getPointerAddressSpace()) | ||||||||||||||
| 1004 | return false; | ||||||||||||||
| 1005 | for (unsigned ArgI = 0; ArgI < C->arg_size(); ++ArgI) | ||||||||||||||
| 1006 | if (C->getArgOperand(ArgI)->stripPointerCasts() == cpySrc && | ||||||||||||||
| 1007 | cpySrc->getType()->getPointerAddressSpace() != | ||||||||||||||
| 1008 | C->getArgOperand(ArgI)->getType()->getPointerAddressSpace()) | ||||||||||||||
| 1009 | return false; | ||||||||||||||
| 1010 | |||||||||||||||
| 1011 | // All the checks have passed, so do the transformation. | ||||||||||||||
| 1012 | bool changedArgument = false; | ||||||||||||||
| 1013 | for (unsigned ArgI = 0; ArgI < C->arg_size(); ++ArgI) | ||||||||||||||
| 1014 | if (C->getArgOperand(ArgI)->stripPointerCasts() == cpySrc) { | ||||||||||||||
| 1015 | Value *Dest = cpySrc->getType() == cpyDest->getType() ? cpyDest | ||||||||||||||
| 1016 | : CastInst::CreatePointerCast(cpyDest, cpySrc->getType(), | ||||||||||||||
| 1017 | cpyDest->getName(), C); | ||||||||||||||
| 1018 | changedArgument = true; | ||||||||||||||
| 1019 | if (C->getArgOperand(ArgI)->getType() == Dest->getType()) | ||||||||||||||
| 1020 | C->setArgOperand(ArgI, Dest); | ||||||||||||||
| 1021 | else | ||||||||||||||
| 1022 | C->setArgOperand(ArgI, CastInst::CreatePointerCast( | ||||||||||||||
| 1023 | Dest, C->getArgOperand(ArgI)->getType(), | ||||||||||||||
| 1024 | Dest->getName(), C)); | ||||||||||||||
| 1025 | } | ||||||||||||||
| 1026 | |||||||||||||||
| 1027 | if (!changedArgument) | ||||||||||||||
| 1028 | return false; | ||||||||||||||
| 1029 | |||||||||||||||
| 1030 | // If the destination wasn't sufficiently aligned then increase its alignment. | ||||||||||||||
| 1031 | if (!isDestSufficientlyAligned) { | ||||||||||||||
| 1032 | assert(isa<AllocaInst>(cpyDest) && "Can only increase alloca alignment!")((void)0); | ||||||||||||||
| 1033 | cast<AllocaInst>(cpyDest)->setAlignment(srcAlign); | ||||||||||||||
| 1034 | } | ||||||||||||||
| 1035 | |||||||||||||||
| 1036 | // Drop any cached information about the call, because we may have changed | ||||||||||||||
| 1037 | // its dependence information by changing its parameter. | ||||||||||||||
| 1038 | if (MD) | ||||||||||||||
| 1039 | MD->removeInstruction(C); | ||||||||||||||
| 1040 | |||||||||||||||
| 1041 | // Update AA metadata | ||||||||||||||
| 1042 | // FIXME: MD_tbaa_struct and MD_mem_parallel_loop_access should also be | ||||||||||||||
| 1043 | // handled here, but combineMetadata doesn't support them yet | ||||||||||||||
| 1044 | unsigned KnownIDs[] = {LLVMContext::MD_tbaa, LLVMContext::MD_alias_scope, | ||||||||||||||
| 1045 | LLVMContext::MD_noalias, | ||||||||||||||
| 1046 | LLVMContext::MD_invariant_group, | ||||||||||||||
| 1047 | LLVMContext::MD_access_group}; | ||||||||||||||
| 1048 | combineMetadata(C, cpyLoad, KnownIDs, true); | ||||||||||||||
| 1049 | |||||||||||||||
| 1050 | ++NumCallSlot; | ||||||||||||||
| 1051 | return true; | ||||||||||||||
| 1052 | } | ||||||||||||||
| 1053 | |||||||||||||||
| 1054 | /// We've found that the (upward scanning) memory dependence of memcpy 'M' is | ||||||||||||||
| 1055 | /// the memcpy 'MDep'. Try to simplify M to copy from MDep's input if we can. | ||||||||||||||
| 1056 | bool MemCpyOptPass::processMemCpyMemCpyDependence(MemCpyInst *M, | ||||||||||||||
| 1057 | MemCpyInst *MDep) { | ||||||||||||||
| 1058 | // We can only transforms memcpy's where the dest of one is the source of the | ||||||||||||||
| 1059 | // other. | ||||||||||||||
| 1060 | if (M->getSource() != MDep->getDest() || MDep->isVolatile()) | ||||||||||||||
| 1061 | return false; | ||||||||||||||
| 1062 | |||||||||||||||
| 1063 | // If dep instruction is reading from our current input, then it is a noop | ||||||||||||||
| 1064 | // transfer and substituting the input won't change this instruction. Just | ||||||||||||||
| 1065 | // ignore the input and let someone else zap MDep. This handles cases like: | ||||||||||||||
| 1066 | // memcpy(a <- a) | ||||||||||||||
| 1067 | // memcpy(b <- a) | ||||||||||||||
| 1068 | if (M->getSource() == MDep->getSource()) | ||||||||||||||
| 1069 | return false; | ||||||||||||||
| 1070 | |||||||||||||||
| 1071 | // Second, the length of the memcpy's must be the same, or the preceding one | ||||||||||||||
| 1072 | // must be larger than the following one. | ||||||||||||||
| 1073 | if (MDep->getLength() != M->getLength()) { | ||||||||||||||
| 1074 | ConstantInt *MDepLen = dyn_cast<ConstantInt>(MDep->getLength()); | ||||||||||||||
| 1075 | ConstantInt *MLen = dyn_cast<ConstantInt>(M->getLength()); | ||||||||||||||
| 1076 | if (!MDepLen || !MLen || MDepLen->getZExtValue() < MLen->getZExtValue()) | ||||||||||||||
| 1077 | return false; | ||||||||||||||
| 1078 | } | ||||||||||||||
| 1079 | |||||||||||||||
| 1080 | // Verify that the copied-from memory doesn't change in between the two | ||||||||||||||
| 1081 | // transfers. For example, in: | ||||||||||||||
| 1082 | // memcpy(a <- b) | ||||||||||||||
| 1083 | // *b = 42; | ||||||||||||||
| 1084 | // memcpy(c <- a) | ||||||||||||||
| 1085 | // It would be invalid to transform the second memcpy into memcpy(c <- b). | ||||||||||||||
| 1086 | // | ||||||||||||||
| 1087 | // TODO: If the code between M and MDep is transparent to the destination "c", | ||||||||||||||
| 1088 | // then we could still perform the xform by moving M up to the first memcpy. | ||||||||||||||
| 1089 | if (EnableMemorySSA) { | ||||||||||||||
| 1090 | // TODO: It would be sufficient to check the MDep source up to the memcpy | ||||||||||||||
| 1091 | // size of M, rather than MDep. | ||||||||||||||
| 1092 | if (writtenBetween(MSSA, MemoryLocation::getForSource(MDep), | ||||||||||||||
| 1093 | MSSA->getMemoryAccess(MDep), MSSA->getMemoryAccess(M))) | ||||||||||||||
| 1094 | return false; | ||||||||||||||
| 1095 | } else { | ||||||||||||||
| 1096 | // NOTE: This is conservative, it will stop on any read from the source loc, | ||||||||||||||
| 1097 | // not just the defining memcpy. | ||||||||||||||
| 1098 | MemDepResult SourceDep = | ||||||||||||||
| 1099 | MD->getPointerDependencyFrom(MemoryLocation::getForSource(MDep), false, | ||||||||||||||
| 1100 | M->getIterator(), M->getParent()); | ||||||||||||||
| 1101 | if (!SourceDep.isClobber() || SourceDep.getInst() != MDep) | ||||||||||||||
| 1102 | return false; | ||||||||||||||
| 1103 | } | ||||||||||||||
| 1104 | |||||||||||||||
| 1105 | // If the dest of the second might alias the source of the first, then the | ||||||||||||||
| 1106 | // source and dest might overlap. We still want to eliminate the intermediate | ||||||||||||||
| 1107 | // value, but we have to generate a memmove instead of memcpy. | ||||||||||||||
| 1108 | bool UseMemMove = false; | ||||||||||||||
| 1109 | if (!AA->isNoAlias(MemoryLocation::getForDest(M), | ||||||||||||||
| 1110 | MemoryLocation::getForSource(MDep))) | ||||||||||||||
| 1111 | UseMemMove = true; | ||||||||||||||
| 1112 | |||||||||||||||
| 1113 | // If all checks passed, then we can transform M. | ||||||||||||||
| 1114 | LLVM_DEBUG(dbgs() << "MemCpyOptPass: Forwarding memcpy->memcpy src:\n"do { } while (false) | ||||||||||||||
| 1115 | << *MDep << '\n' << *M << '\n')do { } while (false); | ||||||||||||||
| 1116 | |||||||||||||||
| 1117 | // TODO: Is this worth it if we're creating a less aligned memcpy? For | ||||||||||||||
| 1118 | // example we could be moving from movaps -> movq on x86. | ||||||||||||||
| 1119 | IRBuilder<> Builder(M); | ||||||||||||||
| 1120 | Instruction *NewM; | ||||||||||||||
| 1121 | if (UseMemMove) | ||||||||||||||
| 1122 | NewM = Builder.CreateMemMove(M->getRawDest(), M->getDestAlign(), | ||||||||||||||
| 1123 | MDep->getRawSource(), MDep->getSourceAlign(), | ||||||||||||||
| 1124 | M->getLength(), M->isVolatile()); | ||||||||||||||
| 1125 | else if (isa<MemCpyInlineInst>(M)) { | ||||||||||||||
| 1126 | // llvm.memcpy may be promoted to llvm.memcpy.inline, but the converse is | ||||||||||||||
| 1127 | // never allowed since that would allow the latter to be lowered as a call | ||||||||||||||
| 1128 | // to an external function. | ||||||||||||||
| 1129 | NewM = Builder.CreateMemCpyInline( | ||||||||||||||
| 1130 | M->getRawDest(), M->getDestAlign(), MDep->getRawSource(), | ||||||||||||||
| 1131 | MDep->getSourceAlign(), M->getLength(), M->isVolatile()); | ||||||||||||||
| 1132 | } else | ||||||||||||||
| 1133 | NewM = Builder.CreateMemCpy(M->getRawDest(), M->getDestAlign(), | ||||||||||||||
| 1134 | MDep->getRawSource(), MDep->getSourceAlign(), | ||||||||||||||
| 1135 | M->getLength(), M->isVolatile()); | ||||||||||||||
| 1136 | |||||||||||||||
| 1137 | if (MSSAU) { | ||||||||||||||
| 1138 | assert(isa<MemoryDef>(MSSAU->getMemorySSA()->getMemoryAccess(M)))((void)0); | ||||||||||||||
| 1139 | auto *LastDef = cast<MemoryDef>(MSSAU->getMemorySSA()->getMemoryAccess(M)); | ||||||||||||||
| 1140 | auto *NewAccess = MSSAU->createMemoryAccessAfter(NewM, LastDef, LastDef); | ||||||||||||||
| 1141 | MSSAU->insertDef(cast<MemoryDef>(NewAccess), /*RenameUses=*/true); | ||||||||||||||
| 1142 | } | ||||||||||||||
| 1143 | |||||||||||||||
| 1144 | // Remove the instruction we're replacing. | ||||||||||||||
| 1145 | eraseInstruction(M); | ||||||||||||||
| 1146 | ++NumMemCpyInstr; | ||||||||||||||
| 1147 | return true; | ||||||||||||||
| 1148 | } | ||||||||||||||
| 1149 | |||||||||||||||
| 1150 | /// We've found that the (upward scanning) memory dependence of \p MemCpy is | ||||||||||||||
| 1151 | /// \p MemSet. Try to simplify \p MemSet to only set the trailing bytes that | ||||||||||||||
| 1152 | /// weren't copied over by \p MemCpy. | ||||||||||||||
| 1153 | /// | ||||||||||||||
| 1154 | /// In other words, transform: | ||||||||||||||
| 1155 | /// \code | ||||||||||||||
| 1156 | /// memset(dst, c, dst_size); | ||||||||||||||
| 1157 | /// memcpy(dst, src, src_size); | ||||||||||||||
| 1158 | /// \endcode | ||||||||||||||
| 1159 | /// into: | ||||||||||||||
| 1160 | /// \code | ||||||||||||||
| 1161 | /// memcpy(dst, src, src_size); | ||||||||||||||
| 1162 | /// memset(dst + src_size, c, dst_size <= src_size ? 0 : dst_size - src_size); | ||||||||||||||
| 1163 | /// \endcode | ||||||||||||||
| 1164 | bool MemCpyOptPass::processMemSetMemCpyDependence(MemCpyInst *MemCpy, | ||||||||||||||
| 1165 | MemSetInst *MemSet) { | ||||||||||||||
| 1166 | // We can only transform memset/memcpy with the same destination. | ||||||||||||||
| 1167 | if (!AA->isMustAlias(MemSet->getDest(), MemCpy->getDest())) | ||||||||||||||
| 1168 | return false; | ||||||||||||||
| 1169 | |||||||||||||||
| 1170 | // Check that src and dst of the memcpy aren't the same. While memcpy | ||||||||||||||
| 1171 | // operands cannot partially overlap, exact equality is allowed. | ||||||||||||||
| 1172 | if (!AA->isNoAlias(MemoryLocation(MemCpy->getSource(), | ||||||||||||||
| 1173 | LocationSize::precise(1)), | ||||||||||||||
| 1174 | MemoryLocation(MemCpy->getDest(), | ||||||||||||||
| 1175 | LocationSize::precise(1)))) | ||||||||||||||
| 1176 | return false; | ||||||||||||||
| 1177 | |||||||||||||||
| 1178 | if (EnableMemorySSA) { | ||||||||||||||
| 1179 | // We know that dst up to src_size is not written. We now need to make sure | ||||||||||||||
| 1180 | // that dst up to dst_size is not accessed. (If we did not move the memset, | ||||||||||||||
| 1181 | // checking for reads would be sufficient.) | ||||||||||||||
| 1182 | if (accessedBetween(*AA, MemoryLocation::getForDest(MemSet), | ||||||||||||||
| 1183 | MSSA->getMemoryAccess(MemSet), | ||||||||||||||
| 1184 | MSSA->getMemoryAccess(MemCpy))) { | ||||||||||||||
| 1185 | return false; | ||||||||||||||
| 1186 | } | ||||||||||||||
| 1187 | } else { | ||||||||||||||
| 1188 | // We have already checked that dst up to src_size is not accessed. We | ||||||||||||||
| 1189 | // need to make sure that there are no accesses up to dst_size either. | ||||||||||||||
| 1190 | MemDepResult DstDepInfo = MD->getPointerDependencyFrom( | ||||||||||||||
| 1191 | MemoryLocation::getForDest(MemSet), false, MemCpy->getIterator(), | ||||||||||||||
| 1192 | MemCpy->getParent()); | ||||||||||||||
| 1193 | if (DstDepInfo.getInst() != MemSet) | ||||||||||||||
| 1194 | return false; | ||||||||||||||
| 1195 | } | ||||||||||||||
| 1196 | |||||||||||||||
| 1197 | // Use the same i8* dest as the memcpy, killing the memset dest if different. | ||||||||||||||
| 1198 | Value *Dest = MemCpy->getRawDest(); | ||||||||||||||
| 1199 | Value *DestSize = MemSet->getLength(); | ||||||||||||||
| 1200 | Value *SrcSize = MemCpy->getLength(); | ||||||||||||||
| 1201 | |||||||||||||||
| 1202 | if (mayBeVisibleThroughUnwinding(Dest, MemSet, MemCpy)) | ||||||||||||||
| 1203 | return false; | ||||||||||||||
| 1204 | |||||||||||||||
| 1205 | // If the sizes are the same, simply drop the memset instead of generating | ||||||||||||||
| 1206 | // a replacement with zero size. | ||||||||||||||
| 1207 | if (DestSize == SrcSize) { | ||||||||||||||
| 1208 | eraseInstruction(MemSet); | ||||||||||||||
| 1209 | return true; | ||||||||||||||
| 1210 | } | ||||||||||||||
| 1211 | |||||||||||||||
| 1212 | // By default, create an unaligned memset. | ||||||||||||||
| 1213 | unsigned Align = 1; | ||||||||||||||
| 1214 | // If Dest is aligned, and SrcSize is constant, use the minimum alignment | ||||||||||||||
| 1215 | // of the sum. | ||||||||||||||
| 1216 | const unsigned DestAlign = | ||||||||||||||
| 1217 | std::max(MemSet->getDestAlignment(), MemCpy->getDestAlignment()); | ||||||||||||||
| 1218 | if (DestAlign > 1) | ||||||||||||||
| 1219 | if (ConstantInt *SrcSizeC = dyn_cast<ConstantInt>(SrcSize)) | ||||||||||||||
| 1220 | Align = MinAlign(SrcSizeC->getZExtValue(), DestAlign); | ||||||||||||||
| 1221 | |||||||||||||||
| 1222 | IRBuilder<> Builder(MemCpy); | ||||||||||||||
| 1223 | |||||||||||||||
| 1224 | // If the sizes have different types, zext the smaller one. | ||||||||||||||
| 1225 | if (DestSize->getType() != SrcSize->getType()) { | ||||||||||||||
| 1226 | if (DestSize->getType()->getIntegerBitWidth() > | ||||||||||||||
| 1227 | SrcSize->getType()->getIntegerBitWidth()) | ||||||||||||||
| 1228 | SrcSize = Builder.CreateZExt(SrcSize, DestSize->getType()); | ||||||||||||||
| 1229 | else | ||||||||||||||
| 1230 | DestSize = Builder.CreateZExt(DestSize, SrcSize->getType()); | ||||||||||||||
| 1231 | } | ||||||||||||||
| 1232 | |||||||||||||||
| 1233 | Value *Ule = Builder.CreateICmpULE(DestSize, SrcSize); | ||||||||||||||
| 1234 | Value *SizeDiff = Builder.CreateSub(DestSize, SrcSize); | ||||||||||||||
| 1235 | Value *MemsetLen = Builder.CreateSelect( | ||||||||||||||
| 1236 | Ule, ConstantInt::getNullValue(DestSize->getType()), SizeDiff); | ||||||||||||||
| 1237 | unsigned DestAS = Dest->getType()->getPointerAddressSpace(); | ||||||||||||||
| 1238 | Instruction *NewMemSet = Builder.CreateMemSet( | ||||||||||||||
| 1239 | Builder.CreateGEP(Builder.getInt8Ty(), | ||||||||||||||
| 1240 | Builder.CreatePointerCast(Dest, | ||||||||||||||
| 1241 | Builder.getInt8PtrTy(DestAS)), | ||||||||||||||
| 1242 | SrcSize), | ||||||||||||||
| 1243 | MemSet->getOperand(1), MemsetLen, MaybeAlign(Align)); | ||||||||||||||
| 1244 | |||||||||||||||
| 1245 | if (MSSAU) { | ||||||||||||||
| 1246 | assert(isa<MemoryDef>(MSSAU->getMemorySSA()->getMemoryAccess(MemCpy)) &&((void)0) | ||||||||||||||
| 1247 | "MemCpy must be a MemoryDef")((void)0); | ||||||||||||||
| 1248 | // The new memset is inserted after the memcpy, but it is known that its | ||||||||||||||
| 1249 | // defining access is the memset about to be removed which immediately | ||||||||||||||
| 1250 | // precedes the memcpy. | ||||||||||||||
| 1251 | auto *LastDef = | ||||||||||||||
| 1252 | cast<MemoryDef>(MSSAU->getMemorySSA()->getMemoryAccess(MemCpy)); | ||||||||||||||
| 1253 | auto *NewAccess = MSSAU->createMemoryAccessBefore( | ||||||||||||||
| 1254 | NewMemSet, LastDef->getDefiningAccess(), LastDef); | ||||||||||||||
| 1255 | MSSAU->insertDef(cast<MemoryDef>(NewAccess), /*RenameUses=*/true); | ||||||||||||||
| 1256 | } | ||||||||||||||
| 1257 | |||||||||||||||
| 1258 | eraseInstruction(MemSet); | ||||||||||||||
| 1259 | return true; | ||||||||||||||
| 1260 | } | ||||||||||||||
| 1261 | |||||||||||||||
| 1262 | /// Determine whether the instruction has undefined content for the given Size, | ||||||||||||||
| 1263 | /// either because it was freshly alloca'd or started its lifetime. | ||||||||||||||
| 1264 | static bool hasUndefContents(Instruction *I, Value *Size) { | ||||||||||||||
| 1265 | if (isa<AllocaInst>(I)) | ||||||||||||||
| 1266 | return true; | ||||||||||||||
| 1267 | |||||||||||||||
| 1268 | if (ConstantInt *CSize = dyn_cast<ConstantInt>(Size)) { | ||||||||||||||
| 1269 | if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) | ||||||||||||||
| 1270 | if (II->getIntrinsicID() == Intrinsic::lifetime_start) | ||||||||||||||
| 1271 | if (ConstantInt *LTSize = dyn_cast<ConstantInt>(II->getArgOperand(0))) | ||||||||||||||
| 1272 | if (LTSize->getZExtValue() >= CSize->getZExtValue()) | ||||||||||||||
| 1273 | return true; | ||||||||||||||
| 1274 | } | ||||||||||||||
| 1275 | |||||||||||||||
| 1276 | return false; | ||||||||||||||
| 1277 | } | ||||||||||||||
| 1278 | |||||||||||||||
| 1279 | static bool hasUndefContentsMSSA(MemorySSA *MSSA, AliasAnalysis *AA, Value *V, | ||||||||||||||
| 1280 | MemoryDef *Def, Value *Size) { | ||||||||||||||
| 1281 | if (MSSA->isLiveOnEntryDef(Def)) | ||||||||||||||
| 1282 | return isa<AllocaInst>(getUnderlyingObject(V)); | ||||||||||||||
| 1283 | |||||||||||||||
| 1284 | if (IntrinsicInst *II = | ||||||||||||||
| 1285 | dyn_cast_or_null<IntrinsicInst>(Def->getMemoryInst())) { | ||||||||||||||
| 1286 | if (II->getIntrinsicID() == Intrinsic::lifetime_start) { | ||||||||||||||
| 1287 | ConstantInt *LTSize = cast<ConstantInt>(II->getArgOperand(0)); | ||||||||||||||
| 1288 | |||||||||||||||
| 1289 | if (ConstantInt *CSize = dyn_cast<ConstantInt>(Size)) { | ||||||||||||||
| 1290 | if (AA->isMustAlias(V, II->getArgOperand(1)) && | ||||||||||||||
| 1291 | LTSize->getZExtValue() >= CSize->getZExtValue()) | ||||||||||||||
| 1292 | return true; | ||||||||||||||
| 1293 | } | ||||||||||||||
| 1294 | |||||||||||||||
| 1295 | // If the lifetime.start covers a whole alloca (as it almost always | ||||||||||||||
| 1296 | // does) and we're querying a pointer based on that alloca, then we know | ||||||||||||||
| 1297 | // the memory is definitely undef, regardless of how exactly we alias. | ||||||||||||||
| 1298 | // The size also doesn't matter, as an out-of-bounds access would be UB. | ||||||||||||||
| 1299 | AllocaInst *Alloca = dyn_cast<AllocaInst>(getUnderlyingObject(V)); | ||||||||||||||
| 1300 | if (getUnderlyingObject(II->getArgOperand(1)) == Alloca) { | ||||||||||||||
| 1301 | const DataLayout &DL = Alloca->getModule()->getDataLayout(); | ||||||||||||||
| 1302 | if (Optional<TypeSize> AllocaSize = Alloca->getAllocationSizeInBits(DL)) | ||||||||||||||
| 1303 | if (*AllocaSize == LTSize->getValue() * 8) | ||||||||||||||
| 1304 | return true; | ||||||||||||||
| 1305 | } | ||||||||||||||
| 1306 | } | ||||||||||||||
| 1307 | } | ||||||||||||||
| 1308 | |||||||||||||||
| 1309 | return false; | ||||||||||||||
| 1310 | } | ||||||||||||||
| 1311 | |||||||||||||||
| 1312 | /// Transform memcpy to memset when its source was just memset. | ||||||||||||||
| 1313 | /// In other words, turn: | ||||||||||||||
| 1314 | /// \code | ||||||||||||||
| 1315 | /// memset(dst1, c, dst1_size); | ||||||||||||||
| 1316 | /// memcpy(dst2, dst1, dst2_size); | ||||||||||||||
| 1317 | /// \endcode | ||||||||||||||
| 1318 | /// into: | ||||||||||||||
| 1319 | /// \code | ||||||||||||||
| 1320 | /// memset(dst1, c, dst1_size); | ||||||||||||||
| 1321 | /// memset(dst2, c, dst2_size); | ||||||||||||||
| 1322 | /// \endcode | ||||||||||||||
| 1323 | /// When dst2_size <= dst1_size. | ||||||||||||||
| 1324 | bool MemCpyOptPass::performMemCpyToMemSetOptzn(MemCpyInst *MemCpy, | ||||||||||||||
| 1325 | MemSetInst *MemSet) { | ||||||||||||||
| 1326 | // Make sure that memcpy(..., memset(...), ...), that is we are memsetting and | ||||||||||||||
| 1327 | // memcpying from the same address. Otherwise it is hard to reason about. | ||||||||||||||
| 1328 | if (!AA->isMustAlias(MemSet->getRawDest(), MemCpy->getRawSource())) | ||||||||||||||
| 1329 | return false; | ||||||||||||||
| 1330 | |||||||||||||||
| 1331 | Value *MemSetSize = MemSet->getLength(); | ||||||||||||||
| 1332 | Value *CopySize = MemCpy->getLength(); | ||||||||||||||
| 1333 | |||||||||||||||
| 1334 | if (MemSetSize != CopySize) { | ||||||||||||||
| 1335 | // Make sure the memcpy doesn't read any more than what the memset wrote. | ||||||||||||||
| 1336 | // Don't worry about sizes larger than i64. | ||||||||||||||
| 1337 | |||||||||||||||
| 1338 | // A known memset size is required. | ||||||||||||||
| 1339 | ConstantInt *CMemSetSize = dyn_cast<ConstantInt>(MemSetSize); | ||||||||||||||
| 1340 | if (!CMemSetSize) | ||||||||||||||
| 1341 | return false; | ||||||||||||||
| 1342 | |||||||||||||||
| 1343 | // A known memcpy size is also required. | ||||||||||||||
| 1344 | ConstantInt *CCopySize = dyn_cast<ConstantInt>(CopySize); | ||||||||||||||
| 1345 | if (!CCopySize) | ||||||||||||||
| 1346 | return false; | ||||||||||||||
| 1347 | if (CCopySize->getZExtValue() > CMemSetSize->getZExtValue()) { | ||||||||||||||
| 1348 | // If the memcpy is larger than the memset, but the memory was undef prior | ||||||||||||||
| 1349 | // to the memset, we can just ignore the tail. Technically we're only | ||||||||||||||
| 1350 | // interested in the bytes from MemSetSize..CopySize here, but as we can't | ||||||||||||||
| 1351 | // easily represent this location, we use the full 0..CopySize range. | ||||||||||||||
| 1352 | MemoryLocation MemCpyLoc = MemoryLocation::getForSource(MemCpy); | ||||||||||||||
| 1353 | bool CanReduceSize = false; | ||||||||||||||
| 1354 | if (EnableMemorySSA) { | ||||||||||||||
| 1355 | MemoryUseOrDef *MemSetAccess = MSSA->getMemoryAccess(MemSet); | ||||||||||||||
| 1356 | MemoryAccess *Clobber = MSSA->getWalker()->getClobberingMemoryAccess( | ||||||||||||||
| 1357 | MemSetAccess->getDefiningAccess(), MemCpyLoc); | ||||||||||||||
| 1358 | if (auto *MD = dyn_cast<MemoryDef>(Clobber)) | ||||||||||||||
| 1359 | if (hasUndefContentsMSSA(MSSA, AA, MemCpy->getSource(), MD, CopySize)) | ||||||||||||||
| 1360 | CanReduceSize = true; | ||||||||||||||
| 1361 | } else { | ||||||||||||||
| 1362 | MemDepResult DepInfo = MD->getPointerDependencyFrom( | ||||||||||||||
| 1363 | MemCpyLoc, true, MemSet->getIterator(), MemSet->getParent()); | ||||||||||||||
| 1364 | if (DepInfo.isDef() && hasUndefContents(DepInfo.getInst(), CopySize)) | ||||||||||||||
| 1365 | CanReduceSize = true; | ||||||||||||||
| 1366 | } | ||||||||||||||
| 1367 | |||||||||||||||
| 1368 | if (!CanReduceSize) | ||||||||||||||
| 1369 | return false; | ||||||||||||||
| 1370 | CopySize = MemSetSize; | ||||||||||||||
| 1371 | } | ||||||||||||||
| 1372 | } | ||||||||||||||
| 1373 | |||||||||||||||
| 1374 | IRBuilder<> Builder(MemCpy); | ||||||||||||||
| 1375 | Instruction *NewM = | ||||||||||||||
| 1376 | Builder.CreateMemSet(MemCpy->getRawDest(), MemSet->getOperand(1), | ||||||||||||||
| 1377 | CopySize, MaybeAlign(MemCpy->getDestAlignment())); | ||||||||||||||
| 1378 | if (MSSAU) { | ||||||||||||||
| 1379 | auto *LastDef = | ||||||||||||||
| 1380 | cast<MemoryDef>(MSSAU->getMemorySSA()->getMemoryAccess(MemCpy)); | ||||||||||||||
| 1381 | auto *NewAccess = MSSAU->createMemoryAccessAfter(NewM, LastDef, LastDef); | ||||||||||||||
| 1382 | MSSAU->insertDef(cast<MemoryDef>(NewAccess), /*RenameUses=*/true); | ||||||||||||||
| 1383 | } | ||||||||||||||
| 1384 | |||||||||||||||
| 1385 | return true; | ||||||||||||||
| 1386 | } | ||||||||||||||
| 1387 | |||||||||||||||
| 1388 | /// Perform simplification of memcpy's. If we have memcpy A | ||||||||||||||
| 1389 | /// which copies X to Y, and memcpy B which copies Y to Z, then we can rewrite | ||||||||||||||
| 1390 | /// B to be a memcpy from X to Z (or potentially a memmove, depending on | ||||||||||||||
| 1391 | /// circumstances). This allows later passes to remove the first memcpy | ||||||||||||||
| 1392 | /// altogether. | ||||||||||||||
| 1393 | bool MemCpyOptPass::processMemCpy(MemCpyInst *M, BasicBlock::iterator &BBI) { | ||||||||||||||
| 1394 | // We can only optimize non-volatile memcpy's. | ||||||||||||||
| 1395 | if (M->isVolatile()) return false; | ||||||||||||||
| 1396 | |||||||||||||||
| 1397 | // If the source and destination of the memcpy are the same, then zap it. | ||||||||||||||
| 1398 | if (M->getSource() == M->getDest()) { | ||||||||||||||
| 1399 | ++BBI; | ||||||||||||||
| 1400 | eraseInstruction(M); | ||||||||||||||
| 1401 | return true; | ||||||||||||||
| 1402 | } | ||||||||||||||
| 1403 | |||||||||||||||
| 1404 | // If copying from a constant, try to turn the memcpy into a memset. | ||||||||||||||
| 1405 | if (GlobalVariable *GV = dyn_cast<GlobalVariable>(M->getSource())) | ||||||||||||||
| 1406 | if (GV->isConstant() && GV->hasDefinitiveInitializer()) | ||||||||||||||
| 1407 | if (Value *ByteVal = isBytewiseValue(GV->getInitializer(), | ||||||||||||||
| 1408 | M->getModule()->getDataLayout())) { | ||||||||||||||
| 1409 | IRBuilder<> Builder(M); | ||||||||||||||
| 1410 | Instruction *NewM = | ||||||||||||||
| 1411 | Builder.CreateMemSet(M->getRawDest(), ByteVal, M->getLength(), | ||||||||||||||
| 1412 | MaybeAlign(M->getDestAlignment()), false); | ||||||||||||||
| 1413 | if (MSSAU) { | ||||||||||||||
| 1414 | auto *LastDef = | ||||||||||||||
| 1415 | cast<MemoryDef>(MSSAU->getMemorySSA()->getMemoryAccess(M)); | ||||||||||||||
| 1416 | auto *NewAccess = | ||||||||||||||
| 1417 | MSSAU->createMemoryAccessAfter(NewM, LastDef, LastDef); | ||||||||||||||
| 1418 | MSSAU->insertDef(cast<MemoryDef>(NewAccess), /*RenameUses=*/true); | ||||||||||||||
| 1419 | } | ||||||||||||||
| 1420 | |||||||||||||||
| 1421 | eraseInstruction(M); | ||||||||||||||
| 1422 | ++NumCpyToSet; | ||||||||||||||
| 1423 | return true; | ||||||||||||||
| 1424 | } | ||||||||||||||
| 1425 | |||||||||||||||
| 1426 | if (EnableMemorySSA) { | ||||||||||||||
| 1427 | MemoryUseOrDef *MA = MSSA->getMemoryAccess(M); | ||||||||||||||
| 1428 | MemoryAccess *AnyClobber = MSSA->getWalker()->getClobberingMemoryAccess(MA); | ||||||||||||||
| 1429 | MemoryLocation DestLoc = MemoryLocation::getForDest(M); | ||||||||||||||
| 1430 | const MemoryAccess *DestClobber = | ||||||||||||||
| 1431 | MSSA->getWalker()->getClobberingMemoryAccess(AnyClobber, DestLoc); | ||||||||||||||
| 1432 | |||||||||||||||
| 1433 | // Try to turn a partially redundant memset + memcpy into | ||||||||||||||
| 1434 | // memcpy + smaller memset. We don't need the memcpy size for this. | ||||||||||||||
| 1435 | // The memcpy most post-dom the memset, so limit this to the same basic | ||||||||||||||
| 1436 | // block. A non-local generalization is likely not worthwhile. | ||||||||||||||
| 1437 | if (auto *MD = dyn_cast<MemoryDef>(DestClobber)) | ||||||||||||||
| 1438 | if (auto *MDep = dyn_cast_or_null<MemSetInst>(MD->getMemoryInst())) | ||||||||||||||
| 1439 | if (DestClobber->getBlock() == M->getParent()) | ||||||||||||||
| 1440 | if (processMemSetMemCpyDependence(M, MDep)) | ||||||||||||||
| 1441 | return true; | ||||||||||||||
| 1442 | |||||||||||||||
| 1443 | MemoryAccess *SrcClobber = MSSA->getWalker()->getClobberingMemoryAccess( | ||||||||||||||
| 1444 | AnyClobber, MemoryLocation::getForSource(M)); | ||||||||||||||
| 1445 | |||||||||||||||
| 1446 | // There are four possible optimizations we can do for memcpy: | ||||||||||||||
| 1447 | // a) memcpy-memcpy xform which exposes redundance for DSE. | ||||||||||||||
| 1448 | // b) call-memcpy xform for return slot optimization. | ||||||||||||||
| 1449 | // c) memcpy from freshly alloca'd space or space that has just started | ||||||||||||||
| 1450 | // its lifetime copies undefined data, and we can therefore eliminate | ||||||||||||||
| 1451 | // the memcpy in favor of the data that was already at the destination. | ||||||||||||||
| 1452 | // d) memcpy from a just-memset'd source can be turned into memset. | ||||||||||||||
| 1453 | if (auto *MD = dyn_cast<MemoryDef>(SrcClobber)) { | ||||||||||||||
| 1454 | if (Instruction *MI = MD->getMemoryInst()) { | ||||||||||||||
| 1455 | if (ConstantInt *CopySize = dyn_cast<ConstantInt>(M->getLength())) { | ||||||||||||||
| 1456 | if (auto *C = dyn_cast<CallInst>(MI)) { | ||||||||||||||
| 1457 | // The memcpy must post-dom the call. Limit to the same block for | ||||||||||||||
| 1458 | // now. Additionally, we need to ensure that there are no accesses | ||||||||||||||
| 1459 | // to dest between the call and the memcpy. Accesses to src will be | ||||||||||||||
| 1460 | // checked by performCallSlotOptzn(). | ||||||||||||||
| 1461 | // TODO: Support non-local call-slot optimization? | ||||||||||||||
| 1462 | if (C->getParent() == M->getParent() && | ||||||||||||||
| 1463 | !accessedBetween(*AA, DestLoc, MD, MA)) { | ||||||||||||||
| 1464 | // FIXME: Can we pass in either of dest/src alignment here instead | ||||||||||||||
| 1465 | // of conservatively taking the minimum? | ||||||||||||||
| 1466 | Align Alignment = std::min(M->getDestAlign().valueOrOne(), | ||||||||||||||
| 1467 | M->getSourceAlign().valueOrOne()); | ||||||||||||||
| 1468 | if (performCallSlotOptzn( | ||||||||||||||
| 1469 | M, M, M->getDest(), M->getSource(), | ||||||||||||||
| 1470 | TypeSize::getFixed(CopySize->getZExtValue()), Alignment, | ||||||||||||||
| 1471 | C)) { | ||||||||||||||
| 1472 | LLVM_DEBUG(dbgs() << "Performed call slot optimization:\n"do { } while (false) | ||||||||||||||
| 1473 | << " call: " << *C << "\n"do { } while (false) | ||||||||||||||
| 1474 | << " memcpy: " << *M << "\n")do { } while (false); | ||||||||||||||
| 1475 | eraseInstruction(M); | ||||||||||||||
| 1476 | ++NumMemCpyInstr; | ||||||||||||||
| 1477 | return true; | ||||||||||||||
| 1478 | } | ||||||||||||||
| 1479 | } | ||||||||||||||
| 1480 | } | ||||||||||||||
| 1481 | } | ||||||||||||||
| 1482 | if (auto *MDep = dyn_cast<MemCpyInst>(MI)) | ||||||||||||||
| 1483 | return processMemCpyMemCpyDependence(M, MDep); | ||||||||||||||
| 1484 | if (auto *MDep = dyn_cast<MemSetInst>(MI)) { | ||||||||||||||
| 1485 | if (performMemCpyToMemSetOptzn(M, MDep)) { | ||||||||||||||
| 1486 | LLVM_DEBUG(dbgs() << "Converted memcpy to memset\n")do { } while (false); | ||||||||||||||
| 1487 | eraseInstruction(M); | ||||||||||||||
| 1488 | ++NumCpyToSet; | ||||||||||||||
| 1489 | return true; | ||||||||||||||
| 1490 | } | ||||||||||||||
| 1491 | } | ||||||||||||||
| 1492 | } | ||||||||||||||
| 1493 | |||||||||||||||
| 1494 | if (hasUndefContentsMSSA(MSSA, AA, M->getSource(), MD, M->getLength())) { | ||||||||||||||
| 1495 | LLVM_DEBUG(dbgs() << "Removed memcpy from undef\n")do { } while (false); | ||||||||||||||
| 1496 | eraseInstruction(M); | ||||||||||||||
| 1497 | ++NumMemCpyInstr; | ||||||||||||||
| 1498 | return true; | ||||||||||||||
| 1499 | } | ||||||||||||||
| 1500 | } | ||||||||||||||
| 1501 | } else { | ||||||||||||||
| 1502 | MemDepResult DepInfo = MD->getDependency(M); | ||||||||||||||
| 1503 | |||||||||||||||
| 1504 | // Try to turn a partially redundant memset + memcpy into | ||||||||||||||
| 1505 | // memcpy + smaller memset. We don't need the memcpy size for this. | ||||||||||||||
| 1506 | if (DepInfo.isClobber()) | ||||||||||||||
| 1507 | if (MemSetInst *MDep = dyn_cast<MemSetInst>(DepInfo.getInst())) | ||||||||||||||
| 1508 | if (processMemSetMemCpyDependence(M, MDep)) | ||||||||||||||
| 1509 | return true; | ||||||||||||||
| 1510 | |||||||||||||||
| 1511 | // There are four possible optimizations we can do for memcpy: | ||||||||||||||
| 1512 | // a) memcpy-memcpy xform which exposes redundance for DSE. | ||||||||||||||
| 1513 | // b) call-memcpy xform for return slot optimization. | ||||||||||||||
| 1514 | // c) memcpy from freshly alloca'd space or space that has just started | ||||||||||||||
| 1515 | // its lifetime copies undefined data, and we can therefore eliminate | ||||||||||||||
| 1516 | // the memcpy in favor of the data that was already at the destination. | ||||||||||||||
| 1517 | // d) memcpy from a just-memset'd source can be turned into memset. | ||||||||||||||
| 1518 | if (ConstantInt *CopySize = dyn_cast<ConstantInt>(M->getLength())) { | ||||||||||||||
| 1519 | if (DepInfo.isClobber()) { | ||||||||||||||
| 1520 | if (CallInst *C = dyn_cast<CallInst>(DepInfo.getInst())) { | ||||||||||||||
| 1521 | // FIXME: Can we pass in either of dest/src alignment here instead | ||||||||||||||
| 1522 | // of conservatively taking the minimum? | ||||||||||||||
| 1523 | Align Alignment = std::min(M->getDestAlign().valueOrOne(), | ||||||||||||||
| 1524 | M->getSourceAlign().valueOrOne()); | ||||||||||||||
| 1525 | if (performCallSlotOptzn(M, M, M->getDest(), M->getSource(), | ||||||||||||||
| 1526 | TypeSize::getFixed(CopySize->getZExtValue()), | ||||||||||||||
| 1527 | Alignment, C)) { | ||||||||||||||
| 1528 | eraseInstruction(M); | ||||||||||||||
| 1529 | ++NumMemCpyInstr; | ||||||||||||||
| 1530 | return true; | ||||||||||||||
| 1531 | } | ||||||||||||||
| 1532 | } | ||||||||||||||
| 1533 | } | ||||||||||||||
| 1534 | } | ||||||||||||||
| 1535 | |||||||||||||||
| 1536 | MemoryLocation SrcLoc = MemoryLocation::getForSource(M); | ||||||||||||||
| 1537 | MemDepResult SrcDepInfo = MD->getPointerDependencyFrom( | ||||||||||||||
| 1538 | SrcLoc, true, M->getIterator(), M->getParent()); | ||||||||||||||
| 1539 | |||||||||||||||
| 1540 | if (SrcDepInfo.isClobber()) { | ||||||||||||||
| 1541 | if (MemCpyInst *MDep = dyn_cast<MemCpyInst>(SrcDepInfo.getInst())) | ||||||||||||||
| 1542 | return processMemCpyMemCpyDependence(M, MDep); | ||||||||||||||
| 1543 | } else if (SrcDepInfo.isDef()) { | ||||||||||||||
| 1544 | if (hasUndefContents(SrcDepInfo.getInst(), M->getLength())) { | ||||||||||||||
| 1545 | eraseInstruction(M); | ||||||||||||||
| 1546 | ++NumMemCpyInstr; | ||||||||||||||
| 1547 | return true; | ||||||||||||||
| 1548 | } | ||||||||||||||
| 1549 | } | ||||||||||||||
| 1550 | |||||||||||||||
| 1551 | if (SrcDepInfo.isClobber()) | ||||||||||||||
| 1552 | if (MemSetInst *MDep = dyn_cast<MemSetInst>(SrcDepInfo.getInst())) | ||||||||||||||
| 1553 | if (performMemCpyToMemSetOptzn(M, MDep)) { | ||||||||||||||
| 1554 | eraseInstruction(M); | ||||||||||||||
| 1555 | ++NumCpyToSet; | ||||||||||||||
| 1556 | return true; | ||||||||||||||
| 1557 | } | ||||||||||||||
| 1558 | } | ||||||||||||||
| 1559 | |||||||||||||||
| 1560 | return false; | ||||||||||||||
| 1561 | } | ||||||||||||||
| 1562 | |||||||||||||||
| 1563 | /// Transforms memmove calls to memcpy calls when the src/dst are guaranteed | ||||||||||||||
| 1564 | /// not to alias. | ||||||||||||||
| 1565 | bool MemCpyOptPass::processMemMove(MemMoveInst *M) { | ||||||||||||||
| 1566 | if (!TLI->has(LibFunc_memmove)) | ||||||||||||||
| 1567 | return false; | ||||||||||||||
| 1568 | |||||||||||||||
| 1569 | // See if the pointers alias. | ||||||||||||||
| 1570 | if (!AA->isNoAlias(MemoryLocation::getForDest(M), | ||||||||||||||
| 1571 | MemoryLocation::getForSource(M))) | ||||||||||||||
| 1572 | return false; | ||||||||||||||
| 1573 | |||||||||||||||
| 1574 | LLVM_DEBUG(dbgs() << "MemCpyOptPass: Optimizing memmove -> memcpy: " << *Mdo { } while (false) | ||||||||||||||
| 1575 | << "\n")do { } while (false); | ||||||||||||||
| 1576 | |||||||||||||||
| 1577 | // If not, then we know we can transform this. | ||||||||||||||
| 1578 | Type *ArgTys[3] = { M->getRawDest()->getType(), | ||||||||||||||
| 1579 | M->getRawSource()->getType(), | ||||||||||||||
| 1580 | M->getLength()->getType() }; | ||||||||||||||
| 1581 | M->setCalledFunction(Intrinsic::getDeclaration(M->getModule(), | ||||||||||||||
| 1582 | Intrinsic::memcpy, ArgTys)); | ||||||||||||||
| 1583 | |||||||||||||||
| 1584 | // For MemorySSA nothing really changes (except that memcpy may imply stricter | ||||||||||||||
| 1585 | // aliasing guarantees). | ||||||||||||||
| 1586 | |||||||||||||||
| 1587 | // MemDep may have over conservative information about this instruction, just | ||||||||||||||
| 1588 | // conservatively flush it from the cache. | ||||||||||||||
| 1589 | if (MD) | ||||||||||||||
| 1590 | MD->removeInstruction(M); | ||||||||||||||
| 1591 | |||||||||||||||
| 1592 | ++NumMoveToCpy; | ||||||||||||||
| 1593 | return true; | ||||||||||||||
| 1594 | } | ||||||||||||||
| 1595 | |||||||||||||||
| 1596 | /// This is called on every byval argument in call sites. | ||||||||||||||
| 1597 | bool MemCpyOptPass::processByValArgument(CallBase &CB, unsigned ArgNo) { | ||||||||||||||
| 1598 | const DataLayout &DL = CB.getCaller()->getParent()->getDataLayout(); | ||||||||||||||
| 1599 | // Find out what feeds this byval argument. | ||||||||||||||
| 1600 | Value *ByValArg = CB.getArgOperand(ArgNo); | ||||||||||||||
| 1601 | Type *ByValTy = CB.getParamByValType(ArgNo); | ||||||||||||||
| 1602 | TypeSize ByValSize = DL.getTypeAllocSize(ByValTy); | ||||||||||||||
| 1603 | MemoryLocation Loc(ByValArg, LocationSize::precise(ByValSize)); | ||||||||||||||
| 1604 | MemCpyInst *MDep = nullptr; | ||||||||||||||
| 1605 | if (EnableMemorySSA) { | ||||||||||||||
| 1606 | MemoryUseOrDef *CallAccess = MSSA->getMemoryAccess(&CB); | ||||||||||||||
| 1607 | if (!CallAccess) | ||||||||||||||
| 1608 | return false; | ||||||||||||||
| 1609 | MemoryAccess *Clobber = MSSA->getWalker()->getClobberingMemoryAccess( | ||||||||||||||
| 1610 | CallAccess->getDefiningAccess(), Loc); | ||||||||||||||
| 1611 | if (auto *MD = dyn_cast<MemoryDef>(Clobber)) | ||||||||||||||
| 1612 | MDep = dyn_cast_or_null<MemCpyInst>(MD->getMemoryInst()); | ||||||||||||||
| 1613 | } else { | ||||||||||||||
| 1614 | MemDepResult DepInfo = MD->getPointerDependencyFrom( | ||||||||||||||
| 1615 | Loc, true, CB.getIterator(), CB.getParent()); | ||||||||||||||
| 1616 | if (!DepInfo.isClobber()) | ||||||||||||||
| 1617 | return false; | ||||||||||||||
| 1618 | MDep = dyn_cast<MemCpyInst>(DepInfo.getInst()); | ||||||||||||||
| 1619 | } | ||||||||||||||
| 1620 | |||||||||||||||
| 1621 | // If the byval argument isn't fed by a memcpy, ignore it. If it is fed by | ||||||||||||||
| 1622 | // a memcpy, see if we can byval from the source of the memcpy instead of the | ||||||||||||||
| 1623 | // result. | ||||||||||||||
| 1624 | if (!MDep || MDep->isVolatile() || | ||||||||||||||
| 1625 | ByValArg->stripPointerCasts() != MDep->getDest()) | ||||||||||||||
| 1626 | return false; | ||||||||||||||
| 1627 | |||||||||||||||
| 1628 | // The length of the memcpy must be larger or equal to the size of the byval. | ||||||||||||||
| 1629 | ConstantInt *C1 = dyn_cast<ConstantInt>(MDep->getLength()); | ||||||||||||||
| 1630 | if (!C1 || !TypeSize::isKnownGE( | ||||||||||||||
| 1631 | TypeSize::getFixed(C1->getValue().getZExtValue()), ByValSize)) | ||||||||||||||
| 1632 | return false; | ||||||||||||||
| 1633 | |||||||||||||||
| 1634 | // Get the alignment of the byval. If the call doesn't specify the alignment, | ||||||||||||||
| 1635 | // then it is some target specific value that we can't know. | ||||||||||||||
| 1636 | MaybeAlign ByValAlign = CB.getParamAlign(ArgNo); | ||||||||||||||
| 1637 | if (!ByValAlign) return false; | ||||||||||||||
| 1638 | |||||||||||||||
| 1639 | // If it is greater than the memcpy, then we check to see if we can force the | ||||||||||||||
| 1640 | // source of the memcpy to the alignment we need. If we fail, we bail out. | ||||||||||||||
| 1641 | MaybeAlign MemDepAlign = MDep->getSourceAlign(); | ||||||||||||||
| 1642 | if ((!MemDepAlign || *MemDepAlign < *ByValAlign) && | ||||||||||||||
| 1643 | getOrEnforceKnownAlignment(MDep->getSource(), ByValAlign, DL, &CB, AC, | ||||||||||||||
| 1644 | DT) < *ByValAlign) | ||||||||||||||
| 1645 | return false; | ||||||||||||||
| 1646 | |||||||||||||||
| 1647 | // The address space of the memcpy source must match the byval argument | ||||||||||||||
| 1648 | if (MDep->getSource()->getType()->getPointerAddressSpace() != | ||||||||||||||
| 1649 | ByValArg->getType()->getPointerAddressSpace()) | ||||||||||||||
| 1650 | return false; | ||||||||||||||
| 1651 | |||||||||||||||
| 1652 | // Verify that the copied-from memory doesn't change in between the memcpy and | ||||||||||||||
| 1653 | // the byval call. | ||||||||||||||
| 1654 | // memcpy(a <- b) | ||||||||||||||
| 1655 | // *b = 42; | ||||||||||||||
| 1656 | // foo(*a) | ||||||||||||||
| 1657 | // It would be invalid to transform the second memcpy into foo(*b). | ||||||||||||||
| 1658 | if (EnableMemorySSA) { | ||||||||||||||
| 1659 | if (writtenBetween(MSSA, MemoryLocation::getForSource(MDep), | ||||||||||||||
| 1660 | MSSA->getMemoryAccess(MDep), MSSA->getMemoryAccess(&CB))) | ||||||||||||||
| 1661 | return false; | ||||||||||||||
| 1662 | } else { | ||||||||||||||
| 1663 | // NOTE: This is conservative, it will stop on any read from the source loc, | ||||||||||||||
| 1664 | // not just the defining memcpy. | ||||||||||||||
| 1665 | MemDepResult SourceDep = MD->getPointerDependencyFrom( | ||||||||||||||
| 1666 | MemoryLocation::getForSource(MDep), false, | ||||||||||||||
| 1667 | CB.getIterator(), MDep->getParent()); | ||||||||||||||
| 1668 | if (!SourceDep.isClobber() || SourceDep.getInst() != MDep) | ||||||||||||||
| 1669 | return false; | ||||||||||||||
| 1670 | } | ||||||||||||||
| 1671 | |||||||||||||||
| 1672 | Value *TmpCast = MDep->getSource(); | ||||||||||||||
| 1673 | if (MDep->getSource()->getType() != ByValArg->getType()) { | ||||||||||||||
| 1674 | BitCastInst *TmpBitCast = new BitCastInst(MDep->getSource(), ByValArg->getType(), | ||||||||||||||
| 1675 | "tmpcast", &CB); | ||||||||||||||
| 1676 | // Set the tmpcast's DebugLoc to MDep's | ||||||||||||||
| 1677 | TmpBitCast->setDebugLoc(MDep->getDebugLoc()); | ||||||||||||||
| 1678 | TmpCast = TmpBitCast; | ||||||||||||||
| 1679 | } | ||||||||||||||
| 1680 | |||||||||||||||
| 1681 | LLVM_DEBUG(dbgs() << "MemCpyOptPass: Forwarding memcpy to byval:\n"do { } while (false) | ||||||||||||||
| 1682 | << " " << *MDep << "\n"do { } while (false) | ||||||||||||||
| 1683 | << " " << CB << "\n")do { } while (false); | ||||||||||||||
| 1684 | |||||||||||||||
| 1685 | // Otherwise we're good! Update the byval argument. | ||||||||||||||
| 1686 | CB.setArgOperand(ArgNo, TmpCast); | ||||||||||||||
| 1687 | ++NumMemCpyInstr; | ||||||||||||||
| 1688 | return true; | ||||||||||||||
| 1689 | } | ||||||||||||||
| 1690 | |||||||||||||||
| 1691 | /// Executes one iteration of MemCpyOptPass. | ||||||||||||||
| 1692 | bool MemCpyOptPass::iterateOnFunction(Function &F) { | ||||||||||||||
| 1693 | bool MadeChange = false; | ||||||||||||||
| 1694 | |||||||||||||||
| 1695 | // Walk all instruction in the function. | ||||||||||||||
| 1696 | for (BasicBlock &BB : F) { | ||||||||||||||
| 1697 | // Skip unreachable blocks. For example processStore assumes that an | ||||||||||||||
| 1698 | // instruction in a BB can't be dominated by a later instruction in the | ||||||||||||||
| 1699 | // same BB (which is a scenario that can happen for an unreachable BB that | ||||||||||||||
| 1700 | // has itself as a predecessor). | ||||||||||||||
| 1701 | if (!DT->isReachableFromEntry(&BB)) | ||||||||||||||
| 1702 | continue; | ||||||||||||||
| 1703 | |||||||||||||||
| 1704 | for (BasicBlock::iterator BI = BB.begin(), BE = BB.end(); BI != BE;) { | ||||||||||||||
| 1705 | // Avoid invalidating the iterator. | ||||||||||||||
| 1706 | Instruction *I = &*BI++; | ||||||||||||||
| 1707 | |||||||||||||||
| 1708 | bool RepeatInstruction = false; | ||||||||||||||
| 1709 | |||||||||||||||
| 1710 | if (StoreInst *SI
| ||||||||||||||
| 1711 | MadeChange |= processStore(SI, BI); | ||||||||||||||
| 1712 | else if (MemSetInst *M = dyn_cast<MemSetInst>(I)) | ||||||||||||||
| 1713 | RepeatInstruction = processMemSet(M, BI); | ||||||||||||||
| 1714 | else if (MemCpyInst *M = dyn_cast<MemCpyInst>(I)) | ||||||||||||||
| 1715 | RepeatInstruction = processMemCpy(M, BI); | ||||||||||||||
| 1716 | else if (MemMoveInst *M = dyn_cast<MemMoveInst>(I)) | ||||||||||||||
| 1717 | RepeatInstruction = processMemMove(M); | ||||||||||||||
| 1718 | else if (auto *CB = dyn_cast<CallBase>(I)) { | ||||||||||||||
| 1719 | for (unsigned i = 0, e = CB->arg_size(); i != e; ++i) | ||||||||||||||
| 1720 | if (CB->isByValArgument(i)) | ||||||||||||||
| 1721 | MadeChange |= processByValArgument(*CB, i); | ||||||||||||||
| 1722 | } | ||||||||||||||
| 1723 | |||||||||||||||
| 1724 | // Reprocess the instruction if desired. | ||||||||||||||
| 1725 | if (RepeatInstruction) { | ||||||||||||||
| 1726 | if (BI != BB.begin()) | ||||||||||||||
| 1727 | --BI; | ||||||||||||||
| 1728 | MadeChange = true; | ||||||||||||||
| 1729 | } | ||||||||||||||
| 1730 | } | ||||||||||||||
| 1731 | } | ||||||||||||||
| 1732 | |||||||||||||||
| 1733 | return MadeChange; | ||||||||||||||
| 1734 | } | ||||||||||||||
| 1735 | |||||||||||||||
| 1736 | PreservedAnalyses MemCpyOptPass::run(Function &F, FunctionAnalysisManager &AM) { | ||||||||||||||
| 1737 | auto *MD = !EnableMemorySSA ? &AM.getResult<MemoryDependenceAnalysis>(F) | ||||||||||||||
| 1738 | : AM.getCachedResult<MemoryDependenceAnalysis>(F); | ||||||||||||||
| 1739 | auto &TLI = AM.getResult<TargetLibraryAnalysis>(F); | ||||||||||||||
| 1740 | auto *AA = &AM.getResult<AAManager>(F); | ||||||||||||||
| 1741 | auto *AC = &AM.getResult<AssumptionAnalysis>(F); | ||||||||||||||
| 1742 | auto *DT = &AM.getResult<DominatorTreeAnalysis>(F); | ||||||||||||||
| 1743 | auto *MSSA = EnableMemorySSA ? &AM.getResult<MemorySSAAnalysis>(F) | ||||||||||||||
| 1744 | : AM.getCachedResult<MemorySSAAnalysis>(F); | ||||||||||||||
| 1745 | |||||||||||||||
| 1746 | bool MadeChange = | ||||||||||||||
| 1747 | runImpl(F, MD, &TLI, AA, AC, DT, MSSA ? &MSSA->getMSSA() : nullptr); | ||||||||||||||
| 1748 | if (!MadeChange) | ||||||||||||||
| 1749 | return PreservedAnalyses::all(); | ||||||||||||||
| 1750 | |||||||||||||||
| 1751 | PreservedAnalyses PA; | ||||||||||||||
| 1752 | PA.preserveSet<CFGAnalyses>(); | ||||||||||||||
| 1753 | if (MD) | ||||||||||||||
| 1754 | PA.preserve<MemoryDependenceAnalysis>(); | ||||||||||||||
| 1755 | if (MSSA) | ||||||||||||||
| 1756 | PA.preserve<MemorySSAAnalysis>(); | ||||||||||||||
| 1757 | return PA; | ||||||||||||||
| 1758 | } | ||||||||||||||
| 1759 | |||||||||||||||
| 1760 | bool MemCpyOptPass::runImpl(Function &F, MemoryDependenceResults *MD_, | ||||||||||||||
| 1761 | TargetLibraryInfo *TLI_, AliasAnalysis *AA_, | ||||||||||||||
| 1762 | AssumptionCache *AC_, DominatorTree *DT_, | ||||||||||||||
| 1763 | MemorySSA *MSSA_) { | ||||||||||||||
| 1764 | bool MadeChange = false; | ||||||||||||||
| 1765 | MD = MD_; | ||||||||||||||
| 1766 | TLI = TLI_; | ||||||||||||||
| 1767 | AA = AA_; | ||||||||||||||
| 1768 | AC = AC_; | ||||||||||||||
| 1769 | DT = DT_; | ||||||||||||||
| 1770 | MSSA = MSSA_; | ||||||||||||||
| 1771 | MemorySSAUpdater MSSAU_(MSSA_); | ||||||||||||||
| 1772 | MSSAU = MSSA_
| ||||||||||||||
| 1773 | // If we don't have at least memset and memcpy, there is little point of doing | ||||||||||||||
| 1774 | // anything here. These are required by a freestanding implementation, so if | ||||||||||||||
| 1775 | // even they are disabled, there is no point in trying hard. | ||||||||||||||
| 1776 | if (!TLI->has(LibFunc_memset) || !TLI->has(LibFunc_memcpy)) | ||||||||||||||
| 1777 | return false; | ||||||||||||||
| 1778 | |||||||||||||||
| 1779 | while (true) { | ||||||||||||||
| 1780 | if (!iterateOnFunction(F)) | ||||||||||||||
| 1781 | break; | ||||||||||||||
| 1782 | MadeChange = true; | ||||||||||||||
| 1783 | } | ||||||||||||||
| 1784 | |||||||||||||||
| 1785 | if (MSSA_ && VerifyMemorySSA) | ||||||||||||||
| 1786 | MSSA_->verifyMemorySSA(); | ||||||||||||||
| 1787 | |||||||||||||||
| 1788 | MD = nullptr; | ||||||||||||||
| 1789 | return MadeChange; | ||||||||||||||
| 1790 | } | ||||||||||||||
| 1791 | |||||||||||||||
| 1792 | /// This is the main transformation entry point for a function. | ||||||||||||||
| 1793 | bool MemCpyOptLegacyPass::runOnFunction(Function &F) { | ||||||||||||||
| 1794 | if (skipFunction(F)) | ||||||||||||||
| |||||||||||||||
| 1795 | return false; | ||||||||||||||
| 1796 | |||||||||||||||
| 1797 | auto *MDWP = !EnableMemorySSA | ||||||||||||||
| 1798 | ? &getAnalysis<MemoryDependenceWrapperPass>() | ||||||||||||||
| 1799 | : getAnalysisIfAvailable<MemoryDependenceWrapperPass>(); | ||||||||||||||
| 1800 | auto *TLI = &getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(F); | ||||||||||||||
| 1801 | auto *AA = &getAnalysis<AAResultsWrapperPass>().getAAResults(); | ||||||||||||||
| 1802 | auto *AC = &getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F); | ||||||||||||||
| 1803 | auto *DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree(); | ||||||||||||||
| 1804 | auto *MSSAWP = EnableMemorySSA | ||||||||||||||
| 1805 | ? &getAnalysis<MemorySSAWrapperPass>() | ||||||||||||||
| 1806 | : getAnalysisIfAvailable<MemorySSAWrapperPass>(); | ||||||||||||||
| 1807 | |||||||||||||||
| 1808 | return Impl.runImpl(F, MDWP ? & MDWP->getMemDep() : nullptr, TLI, AA, AC, DT, | ||||||||||||||
| 1809 | MSSAWP
| ||||||||||||||
| 1810 | } |
| 1 | //===- llvm/Instructions.h - Instruction subclass definitions ---*- C++ -*-===// |
| 2 | // |
| 3 | // 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 |
| 6 | // |
| 7 | //===----------------------------------------------------------------------===// |
| 8 | // |
| 9 | // This file exposes the class definitions of all of the subclasses of the |
| 10 | // Instruction class. This is meant to be an easy way to get access to all |
| 11 | // instruction subclasses. |
| 12 | // |
| 13 | //===----------------------------------------------------------------------===// |
| 14 | |
| 15 | #ifndef LLVM_IR_INSTRUCTIONS_H |
| 16 | #define LLVM_IR_INSTRUCTIONS_H |
| 17 | |
| 18 | #include "llvm/ADT/ArrayRef.h" |
| 19 | #include "llvm/ADT/Bitfields.h" |
| 20 | #include "llvm/ADT/MapVector.h" |
| 21 | #include "llvm/ADT/None.h" |
| 22 | #include "llvm/ADT/STLExtras.h" |
| 23 | #include "llvm/ADT/SmallVector.h" |
| 24 | #include "llvm/ADT/StringRef.h" |
| 25 | #include "llvm/ADT/Twine.h" |
| 26 | #include "llvm/ADT/iterator.h" |
| 27 | #include "llvm/ADT/iterator_range.h" |
| 28 | #include "llvm/IR/Attributes.h" |
| 29 | #include "llvm/IR/BasicBlock.h" |
| 30 | #include "llvm/IR/CallingConv.h" |
| 31 | #include "llvm/IR/CFG.h" |
| 32 | #include "llvm/IR/Constant.h" |
| 33 | #include "llvm/IR/DerivedTypes.h" |
| 34 | #include "llvm/IR/Function.h" |
| 35 | #include "llvm/IR/InstrTypes.h" |
| 36 | #include "llvm/IR/Instruction.h" |
| 37 | #include "llvm/IR/OperandTraits.h" |
| 38 | #include "llvm/IR/Type.h" |
| 39 | #include "llvm/IR/Use.h" |
| 40 | #include "llvm/IR/User.h" |
| 41 | #include "llvm/IR/Value.h" |
| 42 | #include "llvm/Support/AtomicOrdering.h" |
| 43 | #include "llvm/Support/Casting.h" |
| 44 | #include "llvm/Support/ErrorHandling.h" |
| 45 | #include <cassert> |
| 46 | #include <cstddef> |
| 47 | #include <cstdint> |
| 48 | #include <iterator> |
| 49 | |
| 50 | namespace llvm { |
| 51 | |
| 52 | class APInt; |
| 53 | class ConstantInt; |
| 54 | class DataLayout; |
| 55 | class LLVMContext; |
| 56 | |
| 57 | //===----------------------------------------------------------------------===// |
| 58 | // AllocaInst Class |
| 59 | //===----------------------------------------------------------------------===// |
| 60 | |
| 61 | /// an instruction to allocate memory on the stack |
| 62 | class AllocaInst : public UnaryInstruction { |
| 63 | Type *AllocatedType; |
| 64 | |
| 65 | using AlignmentField = AlignmentBitfieldElementT<0>; |
| 66 | using UsedWithInAllocaField = BoolBitfieldElementT<AlignmentField::NextBit>; |
| 67 | using SwiftErrorField = BoolBitfieldElementT<UsedWithInAllocaField::NextBit>; |
| 68 | static_assert(Bitfield::areContiguous<AlignmentField, UsedWithInAllocaField, |
| 69 | SwiftErrorField>(), |
| 70 | "Bitfields must be contiguous"); |
| 71 | |
| 72 | protected: |
| 73 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 74 | friend class Instruction; |
| 75 | |
| 76 | AllocaInst *cloneImpl() const; |
| 77 | |
| 78 | public: |
| 79 | explicit AllocaInst(Type *Ty, unsigned AddrSpace, Value *ArraySize, |
| 80 | const Twine &Name, Instruction *InsertBefore); |
| 81 | AllocaInst(Type *Ty, unsigned AddrSpace, Value *ArraySize, |
| 82 | const Twine &Name, BasicBlock *InsertAtEnd); |
| 83 | |
| 84 | AllocaInst(Type *Ty, unsigned AddrSpace, const Twine &Name, |
| 85 | Instruction *InsertBefore); |
| 86 | AllocaInst(Type *Ty, unsigned AddrSpace, |
| 87 | const Twine &Name, BasicBlock *InsertAtEnd); |
| 88 | |
| 89 | AllocaInst(Type *Ty, unsigned AddrSpace, Value *ArraySize, Align Align, |
| 90 | const Twine &Name = "", Instruction *InsertBefore = nullptr); |
| 91 | AllocaInst(Type *Ty, unsigned AddrSpace, Value *ArraySize, Align Align, |
| 92 | const Twine &Name, BasicBlock *InsertAtEnd); |
| 93 | |
| 94 | /// Return true if there is an allocation size parameter to the allocation |
| 95 | /// instruction that is not 1. |
| 96 | bool isArrayAllocation() const; |
| 97 | |
| 98 | /// Get the number of elements allocated. For a simple allocation of a single |
| 99 | /// element, this will return a constant 1 value. |
| 100 | const Value *getArraySize() const { return getOperand(0); } |
| 101 | Value *getArraySize() { return getOperand(0); } |
| 102 | |
| 103 | /// Overload to return most specific pointer type. |
| 104 | PointerType *getType() const { |
| 105 | return cast<PointerType>(Instruction::getType()); |
| 106 | } |
| 107 | |
| 108 | /// Get allocation size in bits. Returns None if size can't be determined, |
| 109 | /// e.g. in case of a VLA. |
| 110 | Optional<TypeSize> getAllocationSizeInBits(const DataLayout &DL) const; |
| 111 | |
| 112 | /// Return the type that is being allocated by the instruction. |
| 113 | Type *getAllocatedType() const { return AllocatedType; } |
| 114 | /// for use only in special circumstances that need to generically |
| 115 | /// transform a whole instruction (eg: IR linking and vectorization). |
| 116 | void setAllocatedType(Type *Ty) { AllocatedType = Ty; } |
| 117 | |
| 118 | /// Return the alignment of the memory that is being allocated by the |
| 119 | /// instruction. |
| 120 | Align getAlign() const { |
| 121 | return Align(1ULL << getSubclassData<AlignmentField>()); |
| 122 | } |
| 123 | |
| 124 | void setAlignment(Align Align) { |
| 125 | setSubclassData<AlignmentField>(Log2(Align)); |
| 126 | } |
| 127 | |
| 128 | // FIXME: Remove this one transition to Align is over. |
| 129 | unsigned getAlignment() const { return getAlign().value(); } |
| 130 | |
| 131 | /// Return true if this alloca is in the entry block of the function and is a |
| 132 | /// constant size. If so, the code generator will fold it into the |
| 133 | /// prolog/epilog code, so it is basically free. |
| 134 | bool isStaticAlloca() const; |
| 135 | |
| 136 | /// Return true if this alloca is used as an inalloca argument to a call. Such |
| 137 | /// allocas are never considered static even if they are in the entry block. |
| 138 | bool isUsedWithInAlloca() const { |
| 139 | return getSubclassData<UsedWithInAllocaField>(); |
| 140 | } |
| 141 | |
| 142 | /// Specify whether this alloca is used to represent the arguments to a call. |
| 143 | void setUsedWithInAlloca(bool V) { |
| 144 | setSubclassData<UsedWithInAllocaField>(V); |
| 145 | } |
| 146 | |
| 147 | /// Return true if this alloca is used as a swifterror argument to a call. |
| 148 | bool isSwiftError() const { return getSubclassData<SwiftErrorField>(); } |
| 149 | /// Specify whether this alloca is used to represent a swifterror. |
| 150 | void setSwiftError(bool V) { setSubclassData<SwiftErrorField>(V); } |
| 151 | |
| 152 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 153 | static bool classof(const Instruction *I) { |
| 154 | return (I->getOpcode() == Instruction::Alloca); |
| 155 | } |
| 156 | static bool classof(const Value *V) { |
| 157 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 158 | } |
| 159 | |
| 160 | private: |
| 161 | // Shadow Instruction::setInstructionSubclassData with a private forwarding |
| 162 | // method so that subclasses cannot accidentally use it. |
| 163 | template <typename Bitfield> |
| 164 | void setSubclassData(typename Bitfield::Type Value) { |
| 165 | Instruction::setSubclassData<Bitfield>(Value); |
| 166 | } |
| 167 | }; |
| 168 | |
| 169 | //===----------------------------------------------------------------------===// |
| 170 | // LoadInst Class |
| 171 | //===----------------------------------------------------------------------===// |
| 172 | |
| 173 | /// An instruction for reading from memory. This uses the SubclassData field in |
| 174 | /// Value to store whether or not the load is volatile. |
| 175 | class LoadInst : public UnaryInstruction { |
| 176 | using VolatileField = BoolBitfieldElementT<0>; |
| 177 | using AlignmentField = AlignmentBitfieldElementT<VolatileField::NextBit>; |
| 178 | using OrderingField = AtomicOrderingBitfieldElementT<AlignmentField::NextBit>; |
| 179 | static_assert( |
| 180 | Bitfield::areContiguous<VolatileField, AlignmentField, OrderingField>(), |
| 181 | "Bitfields must be contiguous"); |
| 182 | |
| 183 | void AssertOK(); |
| 184 | |
| 185 | protected: |
| 186 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 187 | friend class Instruction; |
| 188 | |
| 189 | LoadInst *cloneImpl() const; |
| 190 | |
| 191 | public: |
| 192 | LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, |
| 193 | Instruction *InsertBefore); |
| 194 | LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, BasicBlock *InsertAtEnd); |
| 195 | LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile, |
| 196 | Instruction *InsertBefore); |
| 197 | LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile, |
| 198 | BasicBlock *InsertAtEnd); |
| 199 | LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile, |
| 200 | Align Align, Instruction *InsertBefore = nullptr); |
| 201 | LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile, |
| 202 | Align Align, BasicBlock *InsertAtEnd); |
| 203 | LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile, |
| 204 | Align Align, AtomicOrdering Order, |
| 205 | SyncScope::ID SSID = SyncScope::System, |
| 206 | Instruction *InsertBefore = nullptr); |
| 207 | LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile, |
| 208 | Align Align, AtomicOrdering Order, SyncScope::ID SSID, |
| 209 | BasicBlock *InsertAtEnd); |
| 210 | |
| 211 | /// Return true if this is a load from a volatile memory location. |
| 212 | bool isVolatile() const { return getSubclassData<VolatileField>(); } |
| 213 | |
| 214 | /// Specify whether this is a volatile load or not. |
| 215 | void setVolatile(bool V) { setSubclassData<VolatileField>(V); } |
| 216 | |
| 217 | /// Return the alignment of the access that is being performed. |
| 218 | /// FIXME: Remove this function once transition to Align is over. |
| 219 | /// Use getAlign() instead. |
| 220 | unsigned getAlignment() const { return getAlign().value(); } |
| 221 | |
| 222 | /// Return the alignment of the access that is being performed. |
| 223 | Align getAlign() const { |
| 224 | return Align(1ULL << (getSubclassData<AlignmentField>())); |
| 225 | } |
| 226 | |
| 227 | void setAlignment(Align Align) { |
| 228 | setSubclassData<AlignmentField>(Log2(Align)); |
| 229 | } |
| 230 | |
| 231 | /// Returns the ordering constraint of this load instruction. |
| 232 | AtomicOrdering getOrdering() const { |
| 233 | return getSubclassData<OrderingField>(); |
| 234 | } |
| 235 | /// Sets the ordering constraint of this load instruction. May not be Release |
| 236 | /// or AcquireRelease. |
| 237 | void setOrdering(AtomicOrdering Ordering) { |
| 238 | setSubclassData<OrderingField>(Ordering); |
| 239 | } |
| 240 | |
| 241 | /// Returns the synchronization scope ID of this load instruction. |
| 242 | SyncScope::ID getSyncScopeID() const { |
| 243 | return SSID; |
| 244 | } |
| 245 | |
| 246 | /// Sets the synchronization scope ID of this load instruction. |
| 247 | void setSyncScopeID(SyncScope::ID SSID) { |
| 248 | this->SSID = SSID; |
| 249 | } |
| 250 | |
| 251 | /// Sets the ordering constraint and the synchronization scope ID of this load |
| 252 | /// instruction. |
| 253 | void setAtomic(AtomicOrdering Ordering, |
| 254 | SyncScope::ID SSID = SyncScope::System) { |
| 255 | setOrdering(Ordering); |
| 256 | setSyncScopeID(SSID); |
| 257 | } |
| 258 | |
| 259 | bool isSimple() const { return !isAtomic() && !isVolatile(); } |
| 260 | |
| 261 | bool isUnordered() const { |
| 262 | return (getOrdering() == AtomicOrdering::NotAtomic || |
| 263 | getOrdering() == AtomicOrdering::Unordered) && |
| 264 | !isVolatile(); |
| 265 | } |
| 266 | |
| 267 | Value *getPointerOperand() { return getOperand(0); } |
| 268 | const Value *getPointerOperand() const { return getOperand(0); } |
| 269 | static unsigned getPointerOperandIndex() { return 0U; } |
| 270 | Type *getPointerOperandType() const { return getPointerOperand()->getType(); } |
| 271 | |
| 272 | /// Returns the address space of the pointer operand. |
| 273 | unsigned getPointerAddressSpace() const { |
| 274 | return getPointerOperandType()->getPointerAddressSpace(); |
| 275 | } |
| 276 | |
| 277 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 278 | static bool classof(const Instruction *I) { |
| 279 | return I->getOpcode() == Instruction::Load; |
| 280 | } |
| 281 | static bool classof(const Value *V) { |
| 282 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 283 | } |
| 284 | |
| 285 | private: |
| 286 | // Shadow Instruction::setInstructionSubclassData with a private forwarding |
| 287 | // method so that subclasses cannot accidentally use it. |
| 288 | template <typename Bitfield> |
| 289 | void setSubclassData(typename Bitfield::Type Value) { |
| 290 | Instruction::setSubclassData<Bitfield>(Value); |
| 291 | } |
| 292 | |
| 293 | /// The synchronization scope ID of this load instruction. Not quite enough |
| 294 | /// room in SubClassData for everything, so synchronization scope ID gets its |
| 295 | /// own field. |
| 296 | SyncScope::ID SSID; |
| 297 | }; |
| 298 | |
| 299 | //===----------------------------------------------------------------------===// |
| 300 | // StoreInst Class |
| 301 | //===----------------------------------------------------------------------===// |
| 302 | |
| 303 | /// An instruction for storing to memory. |
| 304 | class StoreInst : public Instruction { |
| 305 | using VolatileField = BoolBitfieldElementT<0>; |
| 306 | using AlignmentField = AlignmentBitfieldElementT<VolatileField::NextBit>; |
| 307 | using OrderingField = AtomicOrderingBitfieldElementT<AlignmentField::NextBit>; |
| 308 | static_assert( |
| 309 | Bitfield::areContiguous<VolatileField, AlignmentField, OrderingField>(), |
| 310 | "Bitfields must be contiguous"); |
| 311 | |
| 312 | void AssertOK(); |
| 313 | |
| 314 | protected: |
| 315 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 316 | friend class Instruction; |
| 317 | |
| 318 | StoreInst *cloneImpl() const; |
| 319 | |
| 320 | public: |
| 321 | StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore); |
| 322 | StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd); |
| 323 | StoreInst(Value *Val, Value *Ptr, bool isVolatile, Instruction *InsertBefore); |
| 324 | StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd); |
| 325 | StoreInst(Value *Val, Value *Ptr, bool isVolatile, Align Align, |
| 326 | Instruction *InsertBefore = nullptr); |
| 327 | StoreInst(Value *Val, Value *Ptr, bool isVolatile, Align Align, |
| 328 | BasicBlock *InsertAtEnd); |
| 329 | StoreInst(Value *Val, Value *Ptr, bool isVolatile, Align Align, |
| 330 | AtomicOrdering Order, SyncScope::ID SSID = SyncScope::System, |
| 331 | Instruction *InsertBefore = nullptr); |
| 332 | StoreInst(Value *Val, Value *Ptr, bool isVolatile, Align Align, |
| 333 | AtomicOrdering Order, SyncScope::ID SSID, BasicBlock *InsertAtEnd); |
| 334 | |
| 335 | // allocate space for exactly two operands |
| 336 | void *operator new(size_t S) { return User::operator new(S, 2); } |
| 337 | void operator delete(void *Ptr) { User::operator delete(Ptr); } |
| 338 | |
| 339 | /// Return true if this is a store to a volatile memory location. |
| 340 | bool isVolatile() const { return getSubclassData<VolatileField>(); } |
| 341 | |
| 342 | /// Specify whether this is a volatile store or not. |
| 343 | void setVolatile(bool V) { setSubclassData<VolatileField>(V); } |
| 344 | |
| 345 | /// Transparently provide more efficient getOperand methods. |
| 346 | DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void setOperand(unsigned, Value*); inline op_iterator op_begin(); inline const_op_iterator op_begin() const; inline op_iterator op_end(); inline const_op_iterator op_end() const; protected : template <int> inline Use &Op(); template <int > inline const Use &Op() const; public: inline unsigned getNumOperands() const; |
| 347 | |
| 348 | /// Return the alignment of the access that is being performed |
| 349 | /// FIXME: Remove this function once transition to Align is over. |
| 350 | /// Use getAlign() instead. |
| 351 | unsigned getAlignment() const { return getAlign().value(); } |
| 352 | |
| 353 | Align getAlign() const { |
| 354 | return Align(1ULL << (getSubclassData<AlignmentField>())); |
| 355 | } |
| 356 | |
| 357 | void setAlignment(Align Align) { |
| 358 | setSubclassData<AlignmentField>(Log2(Align)); |
| 359 | } |
| 360 | |
| 361 | /// Returns the ordering constraint of this store instruction. |
| 362 | AtomicOrdering getOrdering() const { |
| 363 | return getSubclassData<OrderingField>(); |
| 364 | } |
| 365 | |
| 366 | /// Sets the ordering constraint of this store instruction. May not be |
| 367 | /// Acquire or AcquireRelease. |
| 368 | void setOrdering(AtomicOrdering Ordering) { |
| 369 | setSubclassData<OrderingField>(Ordering); |
| 370 | } |
| 371 | |
| 372 | /// Returns the synchronization scope ID of this store instruction. |
| 373 | SyncScope::ID getSyncScopeID() const { |
| 374 | return SSID; |
| 375 | } |
| 376 | |
| 377 | /// Sets the synchronization scope ID of this store instruction. |
| 378 | void setSyncScopeID(SyncScope::ID SSID) { |
| 379 | this->SSID = SSID; |
| 380 | } |
| 381 | |
| 382 | /// Sets the ordering constraint and the synchronization scope ID of this |
| 383 | /// store instruction. |
| 384 | void setAtomic(AtomicOrdering Ordering, |
| 385 | SyncScope::ID SSID = SyncScope::System) { |
| 386 | setOrdering(Ordering); |
| 387 | setSyncScopeID(SSID); |
| 388 | } |
| 389 | |
| 390 | bool isSimple() const { return !isAtomic() && !isVolatile(); } |
| 391 | |
| 392 | bool isUnordered() const { |
| 393 | return (getOrdering() == AtomicOrdering::NotAtomic || |
| 394 | getOrdering() == AtomicOrdering::Unordered) && |
| 395 | !isVolatile(); |
| 396 | } |
| 397 | |
| 398 | Value *getValueOperand() { return getOperand(0); } |
| 399 | const Value *getValueOperand() const { return getOperand(0); } |
| 400 | |
| 401 | Value *getPointerOperand() { return getOperand(1); } |
| 402 | const Value *getPointerOperand() const { return getOperand(1); } |
| 403 | static unsigned getPointerOperandIndex() { return 1U; } |
| 404 | Type *getPointerOperandType() const { return getPointerOperand()->getType(); } |
| 405 | |
| 406 | /// Returns the address space of the pointer operand. |
| 407 | unsigned getPointerAddressSpace() const { |
| 408 | return getPointerOperandType()->getPointerAddressSpace(); |
| 409 | } |
| 410 | |
| 411 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 412 | static bool classof(const Instruction *I) { |
| 413 | return I->getOpcode() == Instruction::Store; |
| 414 | } |
| 415 | static bool classof(const Value *V) { |
| 416 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 417 | } |
| 418 | |
| 419 | private: |
| 420 | // Shadow Instruction::setInstructionSubclassData with a private forwarding |
| 421 | // method so that subclasses cannot accidentally use it. |
| 422 | template <typename Bitfield> |
| 423 | void setSubclassData(typename Bitfield::Type Value) { |
| 424 | Instruction::setSubclassData<Bitfield>(Value); |
| 425 | } |
| 426 | |
| 427 | /// The synchronization scope ID of this store instruction. Not quite enough |
| 428 | /// room in SubClassData for everything, so synchronization scope ID gets its |
| 429 | /// own field. |
| 430 | SyncScope::ID SSID; |
| 431 | }; |
| 432 | |
| 433 | template <> |
| 434 | struct OperandTraits<StoreInst> : public FixedNumOperandTraits<StoreInst, 2> { |
| 435 | }; |
| 436 | |
| 437 | DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)StoreInst::op_iterator StoreInst::op_begin() { return OperandTraits <StoreInst>::op_begin(this); } StoreInst::const_op_iterator StoreInst::op_begin() const { return OperandTraits<StoreInst >::op_begin(const_cast<StoreInst*>(this)); } StoreInst ::op_iterator StoreInst::op_end() { return OperandTraits<StoreInst >::op_end(this); } StoreInst::const_op_iterator StoreInst:: op_end() const { return OperandTraits<StoreInst>::op_end (const_cast<StoreInst*>(this)); } Value *StoreInst::getOperand (unsigned i_nocapture) const { ((void)0); return cast_or_null <Value>( OperandTraits<StoreInst>::op_begin(const_cast <StoreInst*>(this))[i_nocapture].get()); } void StoreInst ::setOperand(unsigned i_nocapture, Value *Val_nocapture) { (( void)0); OperandTraits<StoreInst>::op_begin(this)[i_nocapture ] = Val_nocapture; } unsigned StoreInst::getNumOperands() const { return OperandTraits<StoreInst>::operands(this); } template <int Idx_nocapture> Use &StoreInst::Op() { return this ->OpFrom<Idx_nocapture>(this); } template <int Idx_nocapture > const Use &StoreInst::Op() const { return this->OpFrom <Idx_nocapture>(this); } |
| 438 | |
| 439 | //===----------------------------------------------------------------------===// |
| 440 | // FenceInst Class |
| 441 | //===----------------------------------------------------------------------===// |
| 442 | |
| 443 | /// An instruction for ordering other memory operations. |
| 444 | class FenceInst : public Instruction { |
| 445 | using OrderingField = AtomicOrderingBitfieldElementT<0>; |
| 446 | |
| 447 | void Init(AtomicOrdering Ordering, SyncScope::ID SSID); |
| 448 | |
| 449 | protected: |
| 450 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 451 | friend class Instruction; |
| 452 | |
| 453 | FenceInst *cloneImpl() const; |
| 454 | |
| 455 | public: |
| 456 | // Ordering may only be Acquire, Release, AcquireRelease, or |
| 457 | // SequentiallyConsistent. |
| 458 | FenceInst(LLVMContext &C, AtomicOrdering Ordering, |
| 459 | SyncScope::ID SSID = SyncScope::System, |
| 460 | Instruction *InsertBefore = nullptr); |
| 461 | FenceInst(LLVMContext &C, AtomicOrdering Ordering, SyncScope::ID SSID, |
| 462 | BasicBlock *InsertAtEnd); |
| 463 | |
| 464 | // allocate space for exactly zero operands |
| 465 | void *operator new(size_t S) { return User::operator new(S, 0); } |
| 466 | void operator delete(void *Ptr) { User::operator delete(Ptr); } |
| 467 | |
| 468 | /// Returns the ordering constraint of this fence instruction. |
| 469 | AtomicOrdering getOrdering() const { |
| 470 | return getSubclassData<OrderingField>(); |
| 471 | } |
| 472 | |
| 473 | /// Sets the ordering constraint of this fence instruction. May only be |
| 474 | /// Acquire, Release, AcquireRelease, or SequentiallyConsistent. |
| 475 | void setOrdering(AtomicOrdering Ordering) { |
| 476 | setSubclassData<OrderingField>(Ordering); |
| 477 | } |
| 478 | |
| 479 | /// Returns the synchronization scope ID of this fence instruction. |
| 480 | SyncScope::ID getSyncScopeID() const { |
| 481 | return SSID; |
| 482 | } |
| 483 | |
| 484 | /// Sets the synchronization scope ID of this fence instruction. |
| 485 | void setSyncScopeID(SyncScope::ID SSID) { |
| 486 | this->SSID = SSID; |
| 487 | } |
| 488 | |
| 489 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 490 | static bool classof(const Instruction *I) { |
| 491 | return I->getOpcode() == Instruction::Fence; |
| 492 | } |
| 493 | static bool classof(const Value *V) { |
| 494 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 495 | } |
| 496 | |
| 497 | private: |
| 498 | // Shadow Instruction::setInstructionSubclassData with a private forwarding |
| 499 | // method so that subclasses cannot accidentally use it. |
| 500 | template <typename Bitfield> |
| 501 | void setSubclassData(typename Bitfield::Type Value) { |
| 502 | Instruction::setSubclassData<Bitfield>(Value); |
| 503 | } |
| 504 | |
| 505 | /// The synchronization scope ID of this fence instruction. Not quite enough |
| 506 | /// room in SubClassData for everything, so synchronization scope ID gets its |
| 507 | /// own field. |
| 508 | SyncScope::ID SSID; |
| 509 | }; |
| 510 | |
| 511 | //===----------------------------------------------------------------------===// |
| 512 | // AtomicCmpXchgInst Class |
| 513 | //===----------------------------------------------------------------------===// |
| 514 | |
| 515 | /// An instruction that atomically checks whether a |
| 516 | /// specified value is in a memory location, and, if it is, stores a new value |
| 517 | /// there. The value returned by this instruction is a pair containing the |
| 518 | /// original value as first element, and an i1 indicating success (true) or |
| 519 | /// failure (false) as second element. |
| 520 | /// |
| 521 | class AtomicCmpXchgInst : public Instruction { |
| 522 | void Init(Value *Ptr, Value *Cmp, Value *NewVal, Align Align, |
| 523 | AtomicOrdering SuccessOrdering, AtomicOrdering FailureOrdering, |
| 524 | SyncScope::ID SSID); |
| 525 | |
| 526 | template <unsigned Offset> |
| 527 | using AtomicOrderingBitfieldElement = |
| 528 | typename Bitfield::Element<AtomicOrdering, Offset, 3, |
| 529 | AtomicOrdering::LAST>; |
| 530 | |
| 531 | protected: |
| 532 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 533 | friend class Instruction; |
| 534 | |
| 535 | AtomicCmpXchgInst *cloneImpl() const; |
| 536 | |
| 537 | public: |
| 538 | AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal, Align Alignment, |
| 539 | AtomicOrdering SuccessOrdering, |
| 540 | AtomicOrdering FailureOrdering, SyncScope::ID SSID, |
| 541 | Instruction *InsertBefore = nullptr); |
| 542 | AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal, Align Alignment, |
| 543 | AtomicOrdering SuccessOrdering, |
| 544 | AtomicOrdering FailureOrdering, SyncScope::ID SSID, |
| 545 | BasicBlock *InsertAtEnd); |
| 546 | |
| 547 | // allocate space for exactly three operands |
| 548 | void *operator new(size_t S) { return User::operator new(S, 3); } |
| 549 | void operator delete(void *Ptr) { User::operator delete(Ptr); } |
| 550 | |
| 551 | using VolatileField = BoolBitfieldElementT<0>; |
| 552 | using WeakField = BoolBitfieldElementT<VolatileField::NextBit>; |
| 553 | using SuccessOrderingField = |
| 554 | AtomicOrderingBitfieldElementT<WeakField::NextBit>; |
| 555 | using FailureOrderingField = |
| 556 | AtomicOrderingBitfieldElementT<SuccessOrderingField::NextBit>; |
| 557 | using AlignmentField = |
| 558 | AlignmentBitfieldElementT<FailureOrderingField::NextBit>; |
| 559 | static_assert( |
| 560 | Bitfield::areContiguous<VolatileField, WeakField, SuccessOrderingField, |
| 561 | FailureOrderingField, AlignmentField>(), |
| 562 | "Bitfields must be contiguous"); |
| 563 | |
| 564 | /// Return the alignment of the memory that is being allocated by the |
| 565 | /// instruction. |
| 566 | Align getAlign() const { |
| 567 | return Align(1ULL << getSubclassData<AlignmentField>()); |
| 568 | } |
| 569 | |
| 570 | void setAlignment(Align Align) { |
| 571 | setSubclassData<AlignmentField>(Log2(Align)); |
| 572 | } |
| 573 | |
| 574 | /// Return true if this is a cmpxchg from a volatile memory |
| 575 | /// location. |
| 576 | /// |
| 577 | bool isVolatile() const { return getSubclassData<VolatileField>(); } |
| 578 | |
| 579 | /// Specify whether this is a volatile cmpxchg. |
| 580 | /// |
| 581 | void setVolatile(bool V) { setSubclassData<VolatileField>(V); } |
| 582 | |
| 583 | /// Return true if this cmpxchg may spuriously fail. |
| 584 | bool isWeak() const { return getSubclassData<WeakField>(); } |
| 585 | |
| 586 | void setWeak(bool IsWeak) { setSubclassData<WeakField>(IsWeak); } |
| 587 | |
| 588 | /// Transparently provide more efficient getOperand methods. |
| 589 | DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void setOperand(unsigned, Value*); inline op_iterator op_begin(); inline const_op_iterator op_begin() const; inline op_iterator op_end(); inline const_op_iterator op_end() const; protected : template <int> inline Use &Op(); template <int > inline const Use &Op() const; public: inline unsigned getNumOperands() const; |
| 590 | |
| 591 | static bool isValidSuccessOrdering(AtomicOrdering Ordering) { |
| 592 | return Ordering != AtomicOrdering::NotAtomic && |
| 593 | Ordering != AtomicOrdering::Unordered; |
| 594 | } |
| 595 | |
| 596 | static bool isValidFailureOrdering(AtomicOrdering Ordering) { |
| 597 | return Ordering != AtomicOrdering::NotAtomic && |
| 598 | Ordering != AtomicOrdering::Unordered && |
| 599 | Ordering != AtomicOrdering::AcquireRelease && |
| 600 | Ordering != AtomicOrdering::Release; |
| 601 | } |
| 602 | |
| 603 | /// Returns the success ordering constraint of this cmpxchg instruction. |
| 604 | AtomicOrdering getSuccessOrdering() const { |
| 605 | return getSubclassData<SuccessOrderingField>(); |
| 606 | } |
| 607 | |
| 608 | /// Sets the success ordering constraint of this cmpxchg instruction. |
| 609 | void setSuccessOrdering(AtomicOrdering Ordering) { |
| 610 | assert(isValidSuccessOrdering(Ordering) &&((void)0) |
| 611 | "invalid CmpXchg success ordering")((void)0); |
| 612 | setSubclassData<SuccessOrderingField>(Ordering); |
| 613 | } |
| 614 | |
| 615 | /// Returns the failure ordering constraint of this cmpxchg instruction. |
| 616 | AtomicOrdering getFailureOrdering() const { |
| 617 | return getSubclassData<FailureOrderingField>(); |
| 618 | } |
| 619 | |
| 620 | /// Sets the failure ordering constraint of this cmpxchg instruction. |
| 621 | void setFailureOrdering(AtomicOrdering Ordering) { |
| 622 | assert(isValidFailureOrdering(Ordering) &&((void)0) |
| 623 | "invalid CmpXchg failure ordering")((void)0); |
| 624 | setSubclassData<FailureOrderingField>(Ordering); |
| 625 | } |
| 626 | |
| 627 | /// Returns a single ordering which is at least as strong as both the |
| 628 | /// success and failure orderings for this cmpxchg. |
| 629 | AtomicOrdering getMergedOrdering() const { |
| 630 | if (getFailureOrdering() == AtomicOrdering::SequentiallyConsistent) |
| 631 | return AtomicOrdering::SequentiallyConsistent; |
| 632 | if (getFailureOrdering() == AtomicOrdering::Acquire) { |
| 633 | if (getSuccessOrdering() == AtomicOrdering::Monotonic) |
| 634 | return AtomicOrdering::Acquire; |
| 635 | if (getSuccessOrdering() == AtomicOrdering::Release) |
| 636 | return AtomicOrdering::AcquireRelease; |
| 637 | } |
| 638 | return getSuccessOrdering(); |
| 639 | } |
| 640 | |
| 641 | /// Returns the synchronization scope ID of this cmpxchg instruction. |
| 642 | SyncScope::ID getSyncScopeID() const { |
| 643 | return SSID; |
| 644 | } |
| 645 | |
| 646 | /// Sets the synchronization scope ID of this cmpxchg instruction. |
| 647 | void setSyncScopeID(SyncScope::ID SSID) { |
| 648 | this->SSID = SSID; |
| 649 | } |
| 650 | |
| 651 | Value *getPointerOperand() { return getOperand(0); } |
| 652 | const Value *getPointerOperand() const { return getOperand(0); } |
| 653 | static unsigned getPointerOperandIndex() { return 0U; } |
| 654 | |
| 655 | Value *getCompareOperand() { return getOperand(1); } |
| 656 | const Value *getCompareOperand() const { return getOperand(1); } |
| 657 | |
| 658 | Value *getNewValOperand() { return getOperand(2); } |
| 659 | const Value *getNewValOperand() const { return getOperand(2); } |
| 660 | |
| 661 | /// Returns the address space of the pointer operand. |
| 662 | unsigned getPointerAddressSpace() const { |
| 663 | return getPointerOperand()->getType()->getPointerAddressSpace(); |
| 664 | } |
| 665 | |
| 666 | /// Returns the strongest permitted ordering on failure, given the |
| 667 | /// desired ordering on success. |
| 668 | /// |
| 669 | /// If the comparison in a cmpxchg operation fails, there is no atomic store |
| 670 | /// so release semantics cannot be provided. So this function drops explicit |
| 671 | /// Release requests from the AtomicOrdering. A SequentiallyConsistent |
| 672 | /// operation would remain SequentiallyConsistent. |
| 673 | static AtomicOrdering |
| 674 | getStrongestFailureOrdering(AtomicOrdering SuccessOrdering) { |
| 675 | switch (SuccessOrdering) { |
| 676 | default: |
| 677 | llvm_unreachable("invalid cmpxchg success ordering")__builtin_unreachable(); |
| 678 | case AtomicOrdering::Release: |
| 679 | case AtomicOrdering::Monotonic: |
| 680 | return AtomicOrdering::Monotonic; |
| 681 | case AtomicOrdering::AcquireRelease: |
| 682 | case AtomicOrdering::Acquire: |
| 683 | return AtomicOrdering::Acquire; |
| 684 | case AtomicOrdering::SequentiallyConsistent: |
| 685 | return AtomicOrdering::SequentiallyConsistent; |
| 686 | } |
| 687 | } |
| 688 | |
| 689 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 690 | static bool classof(const Instruction *I) { |
| 691 | return I->getOpcode() == Instruction::AtomicCmpXchg; |
| 692 | } |
| 693 | static bool classof(const Value *V) { |
| 694 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 695 | } |
| 696 | |
| 697 | private: |
| 698 | // Shadow Instruction::setInstructionSubclassData with a private forwarding |
| 699 | // method so that subclasses cannot accidentally use it. |
| 700 | template <typename Bitfield> |
| 701 | void setSubclassData(typename Bitfield::Type Value) { |
| 702 | Instruction::setSubclassData<Bitfield>(Value); |
| 703 | } |
| 704 | |
| 705 | /// The synchronization scope ID of this cmpxchg instruction. Not quite |
| 706 | /// enough room in SubClassData for everything, so synchronization scope ID |
| 707 | /// gets its own field. |
| 708 | SyncScope::ID SSID; |
| 709 | }; |
| 710 | |
| 711 | template <> |
| 712 | struct OperandTraits<AtomicCmpXchgInst> : |
| 713 | public FixedNumOperandTraits<AtomicCmpXchgInst, 3> { |
| 714 | }; |
| 715 | |
| 716 | DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicCmpXchgInst, Value)AtomicCmpXchgInst::op_iterator AtomicCmpXchgInst::op_begin() { return OperandTraits<AtomicCmpXchgInst>::op_begin(this ); } AtomicCmpXchgInst::const_op_iterator AtomicCmpXchgInst:: op_begin() const { return OperandTraits<AtomicCmpXchgInst> ::op_begin(const_cast<AtomicCmpXchgInst*>(this)); } AtomicCmpXchgInst ::op_iterator AtomicCmpXchgInst::op_end() { return OperandTraits <AtomicCmpXchgInst>::op_end(this); } AtomicCmpXchgInst:: const_op_iterator AtomicCmpXchgInst::op_end() const { return OperandTraits <AtomicCmpXchgInst>::op_end(const_cast<AtomicCmpXchgInst *>(this)); } Value *AtomicCmpXchgInst::getOperand(unsigned i_nocapture) const { ((void)0); return cast_or_null<Value >( OperandTraits<AtomicCmpXchgInst>::op_begin(const_cast <AtomicCmpXchgInst*>(this))[i_nocapture].get()); } void AtomicCmpXchgInst::setOperand(unsigned i_nocapture, Value *Val_nocapture ) { ((void)0); OperandTraits<AtomicCmpXchgInst>::op_begin (this)[i_nocapture] = Val_nocapture; } unsigned AtomicCmpXchgInst ::getNumOperands() const { return OperandTraits<AtomicCmpXchgInst >::operands(this); } template <int Idx_nocapture> Use &AtomicCmpXchgInst::Op() { return this->OpFrom<Idx_nocapture >(this); } template <int Idx_nocapture> const Use & AtomicCmpXchgInst::Op() const { return this->OpFrom<Idx_nocapture >(this); } |
| 717 | |
| 718 | //===----------------------------------------------------------------------===// |
| 719 | // AtomicRMWInst Class |
| 720 | //===----------------------------------------------------------------------===// |
| 721 | |
| 722 | /// an instruction that atomically reads a memory location, |
| 723 | /// combines it with another value, and then stores the result back. Returns |
| 724 | /// the old value. |
| 725 | /// |
| 726 | class AtomicRMWInst : public Instruction { |
| 727 | protected: |
| 728 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 729 | friend class Instruction; |
| 730 | |
| 731 | AtomicRMWInst *cloneImpl() const; |
| 732 | |
| 733 | public: |
| 734 | /// This enumeration lists the possible modifications atomicrmw can make. In |
| 735 | /// the descriptions, 'p' is the pointer to the instruction's memory location, |
| 736 | /// 'old' is the initial value of *p, and 'v' is the other value passed to the |
| 737 | /// instruction. These instructions always return 'old'. |
| 738 | enum BinOp : unsigned { |
| 739 | /// *p = v |
| 740 | Xchg, |
| 741 | /// *p = old + v |
| 742 | Add, |
| 743 | /// *p = old - v |
| 744 | Sub, |
| 745 | /// *p = old & v |
| 746 | And, |
| 747 | /// *p = ~(old & v) |
| 748 | Nand, |
| 749 | /// *p = old | v |
| 750 | Or, |
| 751 | /// *p = old ^ v |
| 752 | Xor, |
| 753 | /// *p = old >signed v ? old : v |
| 754 | Max, |
| 755 | /// *p = old <signed v ? old : v |
| 756 | Min, |
| 757 | /// *p = old >unsigned v ? old : v |
| 758 | UMax, |
| 759 | /// *p = old <unsigned v ? old : v |
| 760 | UMin, |
| 761 | |
| 762 | /// *p = old + v |
| 763 | FAdd, |
| 764 | |
| 765 | /// *p = old - v |
| 766 | FSub, |
| 767 | |
| 768 | FIRST_BINOP = Xchg, |
| 769 | LAST_BINOP = FSub, |
| 770 | BAD_BINOP |
| 771 | }; |
| 772 | |
| 773 | private: |
| 774 | template <unsigned Offset> |
| 775 | using AtomicOrderingBitfieldElement = |
| 776 | typename Bitfield::Element<AtomicOrdering, Offset, 3, |
| 777 | AtomicOrdering::LAST>; |
| 778 | |
| 779 | template <unsigned Offset> |
| 780 | using BinOpBitfieldElement = |
| 781 | typename Bitfield::Element<BinOp, Offset, 4, BinOp::LAST_BINOP>; |
| 782 | |
| 783 | public: |
| 784 | AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val, Align Alignment, |
| 785 | AtomicOrdering Ordering, SyncScope::ID SSID, |
| 786 | Instruction *InsertBefore = nullptr); |
| 787 | AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val, Align Alignment, |
| 788 | AtomicOrdering Ordering, SyncScope::ID SSID, |
| 789 | BasicBlock *InsertAtEnd); |
| 790 | |
| 791 | // allocate space for exactly two operands |
| 792 | void *operator new(size_t S) { return User::operator new(S, 2); } |
| 793 | void operator delete(void *Ptr) { User::operator delete(Ptr); } |
| 794 | |
| 795 | using VolatileField = BoolBitfieldElementT<0>; |
| 796 | using AtomicOrderingField = |
| 797 | AtomicOrderingBitfieldElementT<VolatileField::NextBit>; |
| 798 | using OperationField = BinOpBitfieldElement<AtomicOrderingField::NextBit>; |
| 799 | using AlignmentField = AlignmentBitfieldElementT<OperationField::NextBit>; |
| 800 | static_assert(Bitfield::areContiguous<VolatileField, AtomicOrderingField, |
| 801 | OperationField, AlignmentField>(), |
| 802 | "Bitfields must be contiguous"); |
| 803 | |
| 804 | BinOp getOperation() const { return getSubclassData<OperationField>(); } |
| 805 | |
| 806 | static StringRef getOperationName(BinOp Op); |
| 807 | |
| 808 | static bool isFPOperation(BinOp Op) { |
| 809 | switch (Op) { |
| 810 | case AtomicRMWInst::FAdd: |
| 811 | case AtomicRMWInst::FSub: |
| 812 | return true; |
| 813 | default: |
| 814 | return false; |
| 815 | } |
| 816 | } |
| 817 | |
| 818 | void setOperation(BinOp Operation) { |
| 819 | setSubclassData<OperationField>(Operation); |
| 820 | } |
| 821 | |
| 822 | /// Return the alignment of the memory that is being allocated by the |
| 823 | /// instruction. |
| 824 | Align getAlign() const { |
| 825 | return Align(1ULL << getSubclassData<AlignmentField>()); |
| 826 | } |
| 827 | |
| 828 | void setAlignment(Align Align) { |
| 829 | setSubclassData<AlignmentField>(Log2(Align)); |
| 830 | } |
| 831 | |
| 832 | /// Return true if this is a RMW on a volatile memory location. |
| 833 | /// |
| 834 | bool isVolatile() const { return getSubclassData<VolatileField>(); } |
| 835 | |
| 836 | /// Specify whether this is a volatile RMW or not. |
| 837 | /// |
| 838 | void setVolatile(bool V) { setSubclassData<VolatileField>(V); } |
| 839 | |
| 840 | /// Transparently provide more efficient getOperand methods. |
| 841 | DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void setOperand(unsigned, Value*); inline op_iterator op_begin(); inline const_op_iterator op_begin() const; inline op_iterator op_end(); inline const_op_iterator op_end() const; protected : template <int> inline Use &Op(); template <int > inline const Use &Op() const; public: inline unsigned getNumOperands() const; |
| 842 | |
| 843 | /// Returns the ordering constraint of this rmw instruction. |
| 844 | AtomicOrdering getOrdering() const { |
| 845 | return getSubclassData<AtomicOrderingField>(); |
| 846 | } |
| 847 | |
| 848 | /// Sets the ordering constraint of this rmw instruction. |
| 849 | void setOrdering(AtomicOrdering Ordering) { |
| 850 | assert(Ordering != AtomicOrdering::NotAtomic &&((void)0) |
| 851 | "atomicrmw instructions can only be atomic.")((void)0); |
| 852 | setSubclassData<AtomicOrderingField>(Ordering); |
| 853 | } |
| 854 | |
| 855 | /// Returns the synchronization scope ID of this rmw instruction. |
| 856 | SyncScope::ID getSyncScopeID() const { |
| 857 | return SSID; |
| 858 | } |
| 859 | |
| 860 | /// Sets the synchronization scope ID of this rmw instruction. |
| 861 | void setSyncScopeID(SyncScope::ID SSID) { |
| 862 | this->SSID = SSID; |
| 863 | } |
| 864 | |
| 865 | Value *getPointerOperand() { return getOperand(0); } |
| 866 | const Value *getPointerOperand() const { return getOperand(0); } |
| 867 | static unsigned getPointerOperandIndex() { return 0U; } |
| 868 | |
| 869 | Value *getValOperand() { return getOperand(1); } |
| 870 | const Value *getValOperand() const { return getOperand(1); } |
| 871 | |
| 872 | /// Returns the address space of the pointer operand. |
| 873 | unsigned getPointerAddressSpace() const { |
| 874 | return getPointerOperand()->getType()->getPointerAddressSpace(); |
| 875 | } |
| 876 | |
| 877 | bool isFloatingPointOperation() const { |
| 878 | return isFPOperation(getOperation()); |
| 879 | } |
| 880 | |
| 881 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 882 | static bool classof(const Instruction *I) { |
| 883 | return I->getOpcode() == Instruction::AtomicRMW; |
| 884 | } |
| 885 | static bool classof(const Value *V) { |
| 886 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 887 | } |
| 888 | |
| 889 | private: |
| 890 | void Init(BinOp Operation, Value *Ptr, Value *Val, Align Align, |
| 891 | AtomicOrdering Ordering, SyncScope::ID SSID); |
| 892 | |
| 893 | // Shadow Instruction::setInstructionSubclassData with a private forwarding |
| 894 | // method so that subclasses cannot accidentally use it. |
| 895 | template <typename Bitfield> |
| 896 | void setSubclassData(typename Bitfield::Type Value) { |
| 897 | Instruction::setSubclassData<Bitfield>(Value); |
| 898 | } |
| 899 | |
| 900 | /// The synchronization scope ID of this rmw instruction. Not quite enough |
| 901 | /// room in SubClassData for everything, so synchronization scope ID gets its |
| 902 | /// own field. |
| 903 | SyncScope::ID SSID; |
| 904 | }; |
| 905 | |
| 906 | template <> |
| 907 | struct OperandTraits<AtomicRMWInst> |
| 908 | : public FixedNumOperandTraits<AtomicRMWInst,2> { |
| 909 | }; |
| 910 | |
| 911 | DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicRMWInst, Value)AtomicRMWInst::op_iterator AtomicRMWInst::op_begin() { return OperandTraits<AtomicRMWInst>::op_begin(this); } AtomicRMWInst ::const_op_iterator AtomicRMWInst::op_begin() const { return OperandTraits <AtomicRMWInst>::op_begin(const_cast<AtomicRMWInst*> (this)); } AtomicRMWInst::op_iterator AtomicRMWInst::op_end() { return OperandTraits<AtomicRMWInst>::op_end(this); } AtomicRMWInst::const_op_iterator AtomicRMWInst::op_end() const { return OperandTraits<AtomicRMWInst>::op_end(const_cast <AtomicRMWInst*>(this)); } Value *AtomicRMWInst::getOperand (unsigned i_nocapture) const { ((void)0); return cast_or_null <Value>( OperandTraits<AtomicRMWInst>::op_begin(const_cast <AtomicRMWInst*>(this))[i_nocapture].get()); } void AtomicRMWInst ::setOperand(unsigned i_nocapture, Value *Val_nocapture) { (( void)0); OperandTraits<AtomicRMWInst>::op_begin(this)[i_nocapture ] = Val_nocapture; } unsigned AtomicRMWInst::getNumOperands() const { return OperandTraits<AtomicRMWInst>::operands( this); } template <int Idx_nocapture> Use &AtomicRMWInst ::Op() { return this->OpFrom<Idx_nocapture>(this); } template <int Idx_nocapture> const Use &AtomicRMWInst ::Op() const { return this->OpFrom<Idx_nocapture>(this ); } |
| 912 | |
| 913 | //===----------------------------------------------------------------------===// |
| 914 | // GetElementPtrInst Class |
| 915 | //===----------------------------------------------------------------------===// |
| 916 | |
| 917 | // checkGEPType - Simple wrapper function to give a better assertion failure |
| 918 | // message on bad indexes for a gep instruction. |
| 919 | // |
| 920 | inline Type *checkGEPType(Type *Ty) { |
| 921 | assert(Ty && "Invalid GetElementPtrInst indices for type!")((void)0); |
| 922 | return Ty; |
| 923 | } |
| 924 | |
| 925 | /// an instruction for type-safe pointer arithmetic to |
| 926 | /// access elements of arrays and structs |
| 927 | /// |
| 928 | class GetElementPtrInst : public Instruction { |
| 929 | Type *SourceElementType; |
| 930 | Type *ResultElementType; |
| 931 | |
| 932 | GetElementPtrInst(const GetElementPtrInst &GEPI); |
| 933 | |
| 934 | /// Constructors - Create a getelementptr instruction with a base pointer an |
| 935 | /// list of indices. The first ctor can optionally insert before an existing |
| 936 | /// instruction, the second appends the new instruction to the specified |
| 937 | /// BasicBlock. |
| 938 | inline GetElementPtrInst(Type *PointeeType, Value *Ptr, |
| 939 | ArrayRef<Value *> IdxList, unsigned Values, |
| 940 | const Twine &NameStr, Instruction *InsertBefore); |
| 941 | inline GetElementPtrInst(Type *PointeeType, Value *Ptr, |
| 942 | ArrayRef<Value *> IdxList, unsigned Values, |
| 943 | const Twine &NameStr, BasicBlock *InsertAtEnd); |
| 944 | |
| 945 | void init(Value *Ptr, ArrayRef<Value *> IdxList, const Twine &NameStr); |
| 946 | |
| 947 | protected: |
| 948 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 949 | friend class Instruction; |
| 950 | |
| 951 | GetElementPtrInst *cloneImpl() const; |
| 952 | |
| 953 | public: |
| 954 | static GetElementPtrInst *Create(Type *PointeeType, Value *Ptr, |
| 955 | ArrayRef<Value *> IdxList, |
| 956 | const Twine &NameStr = "", |
| 957 | Instruction *InsertBefore = nullptr) { |
| 958 | unsigned Values = 1 + unsigned(IdxList.size()); |
| 959 | assert(PointeeType && "Must specify element type")((void)0); |
| 960 | assert(cast<PointerType>(Ptr->getType()->getScalarType())((void)0) |
| 961 | ->isOpaqueOrPointeeTypeMatches(PointeeType))((void)0); |
| 962 | return new (Values) GetElementPtrInst(PointeeType, Ptr, IdxList, Values, |
| 963 | NameStr, InsertBefore); |
| 964 | } |
| 965 | |
| 966 | static GetElementPtrInst *Create(Type *PointeeType, Value *Ptr, |
| 967 | ArrayRef<Value *> IdxList, |
| 968 | const Twine &NameStr, |
| 969 | BasicBlock *InsertAtEnd) { |
| 970 | unsigned Values = 1 + unsigned(IdxList.size()); |
| 971 | assert(PointeeType && "Must specify element type")((void)0); |
| 972 | assert(cast<PointerType>(Ptr->getType()->getScalarType())((void)0) |
| 973 | ->isOpaqueOrPointeeTypeMatches(PointeeType))((void)0); |
| 974 | return new (Values) GetElementPtrInst(PointeeType, Ptr, IdxList, Values, |
| 975 | NameStr, InsertAtEnd); |
| 976 | } |
| 977 | |
| 978 | LLVM_ATTRIBUTE_DEPRECATED(static GetElementPtrInst *CreateInBounds([[deprecated("Use the version with explicit element type instead" )]] static GetElementPtrInst *CreateInBounds( Value *Ptr, ArrayRef <Value *> IdxList, const Twine &NameStr = "", Instruction *InsertBefore = nullptr) |
| 979 | Value *Ptr, ArrayRef<Value *> IdxList, const Twine &NameStr = "",[[deprecated("Use the version with explicit element type instead" )]] static GetElementPtrInst *CreateInBounds( Value *Ptr, ArrayRef <Value *> IdxList, const Twine &NameStr = "", Instruction *InsertBefore = nullptr) |
| 980 | Instruction *InsertBefore = nullptr),[[deprecated("Use the version with explicit element type instead" )]] static GetElementPtrInst *CreateInBounds( Value *Ptr, ArrayRef <Value *> IdxList, const Twine &NameStr = "", Instruction *InsertBefore = nullptr) |
| 981 | "Use the version with explicit element type instead")[[deprecated("Use the version with explicit element type instead" )]] static GetElementPtrInst *CreateInBounds( Value *Ptr, ArrayRef <Value *> IdxList, const Twine &NameStr = "", Instruction *InsertBefore = nullptr) { |
| 982 | return CreateInBounds( |
| 983 | Ptr->getType()->getScalarType()->getPointerElementType(), Ptr, IdxList, |
| 984 | NameStr, InsertBefore); |
| 985 | } |
| 986 | |
| 987 | /// Create an "inbounds" getelementptr. See the documentation for the |
| 988 | /// "inbounds" flag in LangRef.html for details. |
| 989 | static GetElementPtrInst * |
| 990 | CreateInBounds(Type *PointeeType, Value *Ptr, ArrayRef<Value *> IdxList, |
| 991 | const Twine &NameStr = "", |
| 992 | Instruction *InsertBefore = nullptr) { |
| 993 | GetElementPtrInst *GEP = |
| 994 | Create(PointeeType, Ptr, IdxList, NameStr, InsertBefore); |
| 995 | GEP->setIsInBounds(true); |
| 996 | return GEP; |
| 997 | } |
| 998 | |
| 999 | LLVM_ATTRIBUTE_DEPRECATED(static GetElementPtrInst *CreateInBounds([[deprecated("Use the version with explicit element type instead" )]] static GetElementPtrInst *CreateInBounds( Value *Ptr, ArrayRef <Value *> IdxList, const Twine &NameStr, BasicBlock *InsertAtEnd) |
| 1000 | Value *Ptr, ArrayRef<Value *> IdxList, const Twine &NameStr,[[deprecated("Use the version with explicit element type instead" )]] static GetElementPtrInst *CreateInBounds( Value *Ptr, ArrayRef <Value *> IdxList, const Twine &NameStr, BasicBlock *InsertAtEnd) |
| 1001 | BasicBlock *InsertAtEnd),[[deprecated("Use the version with explicit element type instead" )]] static GetElementPtrInst *CreateInBounds( Value *Ptr, ArrayRef <Value *> IdxList, const Twine &NameStr, BasicBlock *InsertAtEnd) |
| 1002 | "Use the version with explicit element type instead")[[deprecated("Use the version with explicit element type instead" )]] static GetElementPtrInst *CreateInBounds( Value *Ptr, ArrayRef <Value *> IdxList, const Twine &NameStr, BasicBlock *InsertAtEnd) { |
| 1003 | return CreateInBounds( |
| 1004 | Ptr->getType()->getScalarType()->getPointerElementType(), Ptr, IdxList, |
| 1005 | NameStr, InsertAtEnd); |
| 1006 | } |
| 1007 | |
| 1008 | static GetElementPtrInst *CreateInBounds(Type *PointeeType, Value *Ptr, |
| 1009 | ArrayRef<Value *> IdxList, |
| 1010 | const Twine &NameStr, |
| 1011 | BasicBlock *InsertAtEnd) { |
| 1012 | GetElementPtrInst *GEP = |
| 1013 | Create(PointeeType, Ptr, IdxList, NameStr, InsertAtEnd); |
| 1014 | GEP->setIsInBounds(true); |
| 1015 | return GEP; |
| 1016 | } |
| 1017 | |
| 1018 | /// Transparently provide more efficient getOperand methods. |
| 1019 | DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void setOperand(unsigned, Value*); inline op_iterator op_begin(); inline const_op_iterator op_begin() const; inline op_iterator op_end(); inline const_op_iterator op_end() const; protected : template <int> inline Use &Op(); template <int > inline const Use &Op() const; public: inline unsigned getNumOperands() const; |
| 1020 | |
| 1021 | Type *getSourceElementType() const { return SourceElementType; } |
| 1022 | |
| 1023 | void setSourceElementType(Type *Ty) { SourceElementType = Ty; } |
| 1024 | void setResultElementType(Type *Ty) { ResultElementType = Ty; } |
| 1025 | |
| 1026 | Type *getResultElementType() const { |
| 1027 | assert(cast<PointerType>(getType()->getScalarType())((void)0) |
| 1028 | ->isOpaqueOrPointeeTypeMatches(ResultElementType))((void)0); |
| 1029 | return ResultElementType; |
| 1030 | } |
| 1031 | |
| 1032 | /// Returns the address space of this instruction's pointer type. |
| 1033 | unsigned getAddressSpace() const { |
| 1034 | // Note that this is always the same as the pointer operand's address space |
| 1035 | // and that is cheaper to compute, so cheat here. |
| 1036 | return getPointerAddressSpace(); |
| 1037 | } |
| 1038 | |
| 1039 | /// Returns the result type of a getelementptr with the given source |
| 1040 | /// element type and indexes. |
| 1041 | /// |
| 1042 | /// Null is returned if the indices are invalid for the specified |
| 1043 | /// source element type. |
| 1044 | static Type *getIndexedType(Type *Ty, ArrayRef<Value *> IdxList); |
| 1045 | static Type *getIndexedType(Type *Ty, ArrayRef<Constant *> IdxList); |
| 1046 | static Type *getIndexedType(Type *Ty, ArrayRef<uint64_t> IdxList); |
| 1047 | |
| 1048 | /// Return the type of the element at the given index of an indexable |
| 1049 | /// type. This is equivalent to "getIndexedType(Agg, {Zero, Idx})". |
| 1050 | /// |
| 1051 | /// Returns null if the type can't be indexed, or the given index is not |
| 1052 | /// legal for the given type. |
| 1053 | static Type *getTypeAtIndex(Type *Ty, Value *Idx); |
| 1054 | static Type *getTypeAtIndex(Type *Ty, uint64_t Idx); |
| 1055 | |
| 1056 | inline op_iterator idx_begin() { return op_begin()+1; } |
| 1057 | inline const_op_iterator idx_begin() const { return op_begin()+1; } |
| 1058 | inline op_iterator idx_end() { return op_end(); } |
| 1059 | inline const_op_iterator idx_end() const { return op_end(); } |
| 1060 | |
| 1061 | inline iterator_range<op_iterator> indices() { |
| 1062 | return make_range(idx_begin(), idx_end()); |
| 1063 | } |
| 1064 | |
| 1065 | inline iterator_range<const_op_iterator> indices() const { |
| 1066 | return make_range(idx_begin(), idx_end()); |
| 1067 | } |
| 1068 | |
| 1069 | Value *getPointerOperand() { |
| 1070 | return getOperand(0); |
| 1071 | } |
| 1072 | const Value *getPointerOperand() const { |
| 1073 | return getOperand(0); |
| 1074 | } |
| 1075 | static unsigned getPointerOperandIndex() { |
| 1076 | return 0U; // get index for modifying correct operand. |
| 1077 | } |
| 1078 | |
| 1079 | /// Method to return the pointer operand as a |
| 1080 | /// PointerType. |
| 1081 | Type *getPointerOperandType() const { |
| 1082 | return getPointerOperand()->getType(); |
| 1083 | } |
| 1084 | |
| 1085 | /// Returns the address space of the pointer operand. |
| 1086 | unsigned getPointerAddressSpace() const { |
| 1087 | return getPointerOperandType()->getPointerAddressSpace(); |
| 1088 | } |
| 1089 | |
| 1090 | /// Returns the pointer type returned by the GEP |
| 1091 | /// instruction, which may be a vector of pointers. |
| 1092 | static Type *getGEPReturnType(Type *ElTy, Value *Ptr, |
| 1093 | ArrayRef<Value *> IdxList) { |
| 1094 | PointerType *OrigPtrTy = cast<PointerType>(Ptr->getType()->getScalarType()); |
| 1095 | unsigned AddrSpace = OrigPtrTy->getAddressSpace(); |
| 1096 | Type *ResultElemTy = checkGEPType(getIndexedType(ElTy, IdxList)); |
| 1097 | Type *PtrTy = OrigPtrTy->isOpaque() |
| 1098 | ? PointerType::get(OrigPtrTy->getContext(), AddrSpace) |
| 1099 | : PointerType::get(ResultElemTy, AddrSpace); |
| 1100 | // Vector GEP |
| 1101 | if (auto *PtrVTy = dyn_cast<VectorType>(Ptr->getType())) { |
| 1102 | ElementCount EltCount = PtrVTy->getElementCount(); |
| 1103 | return VectorType::get(PtrTy, EltCount); |
| 1104 | } |
| 1105 | for (Value *Index : IdxList) |
| 1106 | if (auto *IndexVTy = dyn_cast<VectorType>(Index->getType())) { |
| 1107 | ElementCount EltCount = IndexVTy->getElementCount(); |
| 1108 | return VectorType::get(PtrTy, EltCount); |
| 1109 | } |
| 1110 | // Scalar GEP |
| 1111 | return PtrTy; |
| 1112 | } |
| 1113 | |
| 1114 | unsigned getNumIndices() const { // Note: always non-negative |
| 1115 | return getNumOperands() - 1; |
| 1116 | } |
| 1117 | |
| 1118 | bool hasIndices() const { |
| 1119 | return getNumOperands() > 1; |
| 1120 | } |
| 1121 | |
| 1122 | /// Return true if all of the indices of this GEP are |
| 1123 | /// zeros. If so, the result pointer and the first operand have the same |
| 1124 | /// value, just potentially different types. |
| 1125 | bool hasAllZeroIndices() const; |
| 1126 | |
| 1127 | /// Return true if all of the indices of this GEP are |
| 1128 | /// constant integers. If so, the result pointer and the first operand have |
| 1129 | /// a constant offset between them. |
| 1130 | bool hasAllConstantIndices() const; |
| 1131 | |
| 1132 | /// Set or clear the inbounds flag on this GEP instruction. |
| 1133 | /// See LangRef.html for the meaning of inbounds on a getelementptr. |
| 1134 | void setIsInBounds(bool b = true); |
| 1135 | |
| 1136 | /// Determine whether the GEP has the inbounds flag. |
| 1137 | bool isInBounds() const; |
| 1138 | |
| 1139 | /// Accumulate the constant address offset of this GEP if possible. |
| 1140 | /// |
| 1141 | /// This routine accepts an APInt into which it will accumulate the constant |
| 1142 | /// offset of this GEP if the GEP is in fact constant. If the GEP is not |
| 1143 | /// all-constant, it returns false and the value of the offset APInt is |
| 1144 | /// undefined (it is *not* preserved!). The APInt passed into this routine |
| 1145 | /// must be at least as wide as the IntPtr type for the address space of |
| 1146 | /// the base GEP pointer. |
| 1147 | bool accumulateConstantOffset(const DataLayout &DL, APInt &Offset) const; |
| 1148 | bool collectOffset(const DataLayout &DL, unsigned BitWidth, |
| 1149 | MapVector<Value *, APInt> &VariableOffsets, |
| 1150 | APInt &ConstantOffset) const; |
| 1151 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 1152 | static bool classof(const Instruction *I) { |
| 1153 | return (I->getOpcode() == Instruction::GetElementPtr); |
| 1154 | } |
| 1155 | static bool classof(const Value *V) { |
| 1156 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 1157 | } |
| 1158 | }; |
| 1159 | |
| 1160 | template <> |
| 1161 | struct OperandTraits<GetElementPtrInst> : |
| 1162 | public VariadicOperandTraits<GetElementPtrInst, 1> { |
| 1163 | }; |
| 1164 | |
| 1165 | GetElementPtrInst::GetElementPtrInst(Type *PointeeType, Value *Ptr, |
| 1166 | ArrayRef<Value *> IdxList, unsigned Values, |
| 1167 | const Twine &NameStr, |
| 1168 | Instruction *InsertBefore) |
| 1169 | : Instruction(getGEPReturnType(PointeeType, Ptr, IdxList), GetElementPtr, |
| 1170 | OperandTraits<GetElementPtrInst>::op_end(this) - Values, |
| 1171 | Values, InsertBefore), |
| 1172 | SourceElementType(PointeeType), |
| 1173 | ResultElementType(getIndexedType(PointeeType, IdxList)) { |
| 1174 | assert(cast<PointerType>(getType()->getScalarType())((void)0) |
| 1175 | ->isOpaqueOrPointeeTypeMatches(ResultElementType))((void)0); |
| 1176 | init(Ptr, IdxList, NameStr); |
| 1177 | } |
| 1178 | |
| 1179 | GetElementPtrInst::GetElementPtrInst(Type *PointeeType, Value *Ptr, |
| 1180 | ArrayRef<Value *> IdxList, unsigned Values, |
| 1181 | const Twine &NameStr, |
| 1182 | BasicBlock *InsertAtEnd) |
| 1183 | : Instruction(getGEPReturnType(PointeeType, Ptr, IdxList), GetElementPtr, |
| 1184 | OperandTraits<GetElementPtrInst>::op_end(this) - Values, |
| 1185 | Values, InsertAtEnd), |
| 1186 | SourceElementType(PointeeType), |
| 1187 | ResultElementType(getIndexedType(PointeeType, IdxList)) { |
| 1188 | assert(cast<PointerType>(getType()->getScalarType())((void)0) |
| 1189 | ->isOpaqueOrPointeeTypeMatches(ResultElementType))((void)0); |
| 1190 | init(Ptr, IdxList, NameStr); |
| 1191 | } |
| 1192 | |
| 1193 | DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)GetElementPtrInst::op_iterator GetElementPtrInst::op_begin() { return OperandTraits<GetElementPtrInst>::op_begin(this ); } GetElementPtrInst::const_op_iterator GetElementPtrInst:: op_begin() const { return OperandTraits<GetElementPtrInst> ::op_begin(const_cast<GetElementPtrInst*>(this)); } GetElementPtrInst ::op_iterator GetElementPtrInst::op_end() { return OperandTraits <GetElementPtrInst>::op_end(this); } GetElementPtrInst:: const_op_iterator GetElementPtrInst::op_end() const { return OperandTraits <GetElementPtrInst>::op_end(const_cast<GetElementPtrInst *>(this)); } Value *GetElementPtrInst::getOperand(unsigned i_nocapture) const { ((void)0); return cast_or_null<Value >( OperandTraits<GetElementPtrInst>::op_begin(const_cast <GetElementPtrInst*>(this))[i_nocapture].get()); } void GetElementPtrInst::setOperand(unsigned i_nocapture, Value *Val_nocapture ) { ((void)0); OperandTraits<GetElementPtrInst>::op_begin (this)[i_nocapture] = Val_nocapture; } unsigned GetElementPtrInst ::getNumOperands() const { return OperandTraits<GetElementPtrInst >::operands(this); } template <int Idx_nocapture> Use &GetElementPtrInst::Op() { return this->OpFrom<Idx_nocapture >(this); } template <int Idx_nocapture> const Use & GetElementPtrInst::Op() const { return this->OpFrom<Idx_nocapture >(this); } |
| 1194 | |
| 1195 | //===----------------------------------------------------------------------===// |
| 1196 | // ICmpInst Class |
| 1197 | //===----------------------------------------------------------------------===// |
| 1198 | |
| 1199 | /// This instruction compares its operands according to the predicate given |
| 1200 | /// to the constructor. It only operates on integers or pointers. The operands |
| 1201 | /// must be identical types. |
| 1202 | /// Represent an integer comparison operator. |
| 1203 | class ICmpInst: public CmpInst { |
| 1204 | void AssertOK() { |
| 1205 | assert(isIntPredicate() &&((void)0) |
| 1206 | "Invalid ICmp predicate value")((void)0); |
| 1207 | assert(getOperand(0)->getType() == getOperand(1)->getType() &&((void)0) |
| 1208 | "Both operands to ICmp instruction are not of the same type!")((void)0); |
| 1209 | // Check that the operands are the right type |
| 1210 | assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||((void)0) |
| 1211 | getOperand(0)->getType()->isPtrOrPtrVectorTy()) &&((void)0) |
| 1212 | "Invalid operand types for ICmp instruction")((void)0); |
| 1213 | } |
| 1214 | |
| 1215 | protected: |
| 1216 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 1217 | friend class Instruction; |
| 1218 | |
| 1219 | /// Clone an identical ICmpInst |
| 1220 | ICmpInst *cloneImpl() const; |
| 1221 | |
| 1222 | public: |
| 1223 | /// Constructor with insert-before-instruction semantics. |
| 1224 | ICmpInst( |
| 1225 | Instruction *InsertBefore, ///< Where to insert |
| 1226 | Predicate pred, ///< The predicate to use for the comparison |
| 1227 | Value *LHS, ///< The left-hand-side of the expression |
| 1228 | Value *RHS, ///< The right-hand-side of the expression |
| 1229 | const Twine &NameStr = "" ///< Name of the instruction |
| 1230 | ) : CmpInst(makeCmpResultType(LHS->getType()), |
| 1231 | Instruction::ICmp, pred, LHS, RHS, NameStr, |
| 1232 | InsertBefore) { |
| 1233 | #ifndef NDEBUG1 |
| 1234 | AssertOK(); |
| 1235 | #endif |
| 1236 | } |
| 1237 | |
| 1238 | /// Constructor with insert-at-end semantics. |
| 1239 | ICmpInst( |
| 1240 | BasicBlock &InsertAtEnd, ///< Block to insert into. |
| 1241 | Predicate pred, ///< The predicate to use for the comparison |
| 1242 | Value *LHS, ///< The left-hand-side of the expression |
| 1243 | Value *RHS, ///< The right-hand-side of the expression |
| 1244 | const Twine &NameStr = "" ///< Name of the instruction |
| 1245 | ) : CmpInst(makeCmpResultType(LHS->getType()), |
| 1246 | Instruction::ICmp, pred, LHS, RHS, NameStr, |
| 1247 | &InsertAtEnd) { |
| 1248 | #ifndef NDEBUG1 |
| 1249 | AssertOK(); |
| 1250 | #endif |
| 1251 | } |
| 1252 | |
| 1253 | /// Constructor with no-insertion semantics |
| 1254 | ICmpInst( |
| 1255 | Predicate pred, ///< The predicate to use for the comparison |
| 1256 | Value *LHS, ///< The left-hand-side of the expression |
| 1257 | Value *RHS, ///< The right-hand-side of the expression |
| 1258 | const Twine &NameStr = "" ///< Name of the instruction |
| 1259 | ) : CmpInst(makeCmpResultType(LHS->getType()), |
| 1260 | Instruction::ICmp, pred, LHS, RHS, NameStr) { |
| 1261 | #ifndef NDEBUG1 |
| 1262 | AssertOK(); |
| 1263 | #endif |
| 1264 | } |
| 1265 | |
| 1266 | /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc. |
| 1267 | /// @returns the predicate that would be the result if the operand were |
| 1268 | /// regarded as signed. |
| 1269 | /// Return the signed version of the predicate |
| 1270 | Predicate getSignedPredicate() const { |
| 1271 | return getSignedPredicate(getPredicate()); |
| 1272 | } |
| 1273 | |
| 1274 | /// This is a static version that you can use without an instruction. |
| 1275 | /// Return the signed version of the predicate. |
| 1276 | static Predicate getSignedPredicate(Predicate pred); |
| 1277 | |
| 1278 | /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc. |
| 1279 | /// @returns the predicate that would be the result if the operand were |
| 1280 | /// regarded as unsigned. |
| 1281 | /// Return the unsigned version of the predicate |
| 1282 | Predicate getUnsignedPredicate() const { |
| 1283 | return getUnsignedPredicate(getPredicate()); |
| 1284 | } |
| 1285 | |
| 1286 | /// This is a static version that you can use without an instruction. |
| 1287 | /// Return the unsigned version of the predicate. |
| 1288 | static Predicate getUnsignedPredicate(Predicate pred); |
| 1289 | |
| 1290 | /// Return true if this predicate is either EQ or NE. This also |
| 1291 | /// tests for commutativity. |
| 1292 | static bool isEquality(Predicate P) { |
| 1293 | return P == ICMP_EQ || P == ICMP_NE; |
| 1294 | } |
| 1295 | |
| 1296 | /// Return true if this predicate is either EQ or NE. This also |
| 1297 | /// tests for commutativity. |
| 1298 | bool isEquality() const { |
| 1299 | return isEquality(getPredicate()); |
| 1300 | } |
| 1301 | |
| 1302 | /// @returns true if the predicate of this ICmpInst is commutative |
| 1303 | /// Determine if this relation is commutative. |
| 1304 | bool isCommutative() const { return isEquality(); } |
| 1305 | |
| 1306 | /// Return true if the predicate is relational (not EQ or NE). |
| 1307 | /// |
| 1308 | bool isRelational() const { |
| 1309 | return !isEquality(); |
| 1310 | } |
| 1311 | |
| 1312 | /// Return true if the predicate is relational (not EQ or NE). |
| 1313 | /// |
| 1314 | static bool isRelational(Predicate P) { |
| 1315 | return !isEquality(P); |
| 1316 | } |
| 1317 | |
| 1318 | /// Return true if the predicate is SGT or UGT. |
| 1319 | /// |
| 1320 | static bool isGT(Predicate P) { |
| 1321 | return P == ICMP_SGT || P == ICMP_UGT; |
| 1322 | } |
| 1323 | |
| 1324 | /// Return true if the predicate is SLT or ULT. |
| 1325 | /// |
| 1326 | static bool isLT(Predicate P) { |
| 1327 | return P == ICMP_SLT || P == ICMP_ULT; |
| 1328 | } |
| 1329 | |
| 1330 | /// Return true if the predicate is SGE or UGE. |
| 1331 | /// |
| 1332 | static bool isGE(Predicate P) { |
| 1333 | return P == ICMP_SGE || P == ICMP_UGE; |
| 1334 | } |
| 1335 | |
| 1336 | /// Return true if the predicate is SLE or ULE. |
| 1337 | /// |
| 1338 | static bool isLE(Predicate P) { |
| 1339 | return P == ICMP_SLE || P == ICMP_ULE; |
| 1340 | } |
| 1341 | |
| 1342 | /// Exchange the two operands to this instruction in such a way that it does |
| 1343 | /// not modify the semantics of the instruction. The predicate value may be |
| 1344 | /// changed to retain the same result if the predicate is order dependent |
| 1345 | /// (e.g. ult). |
| 1346 | /// Swap operands and adjust predicate. |
| 1347 | void swapOperands() { |
| 1348 | setPredicate(getSwappedPredicate()); |
| 1349 | Op<0>().swap(Op<1>()); |
| 1350 | } |
| 1351 | |
| 1352 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 1353 | static bool classof(const Instruction *I) { |
| 1354 | return I->getOpcode() == Instruction::ICmp; |
| 1355 | } |
| 1356 | static bool classof(const Value *V) { |
| 1357 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 1358 | } |
| 1359 | }; |
| 1360 | |
| 1361 | //===----------------------------------------------------------------------===// |
| 1362 | // FCmpInst Class |
| 1363 | //===----------------------------------------------------------------------===// |
| 1364 | |
| 1365 | /// This instruction compares its operands according to the predicate given |
| 1366 | /// to the constructor. It only operates on floating point values or packed |
| 1367 | /// vectors of floating point values. The operands must be identical types. |
| 1368 | /// Represents a floating point comparison operator. |
| 1369 | class FCmpInst: public CmpInst { |
| 1370 | void AssertOK() { |
| 1371 | assert(isFPPredicate() && "Invalid FCmp predicate value")((void)0); |
| 1372 | assert(getOperand(0)->getType() == getOperand(1)->getType() &&((void)0) |
| 1373 | "Both operands to FCmp instruction are not of the same type!")((void)0); |
| 1374 | // Check that the operands are the right type |
| 1375 | assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&((void)0) |
| 1376 | "Invalid operand types for FCmp instruction")((void)0); |
| 1377 | } |
| 1378 | |
| 1379 | protected: |
| 1380 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 1381 | friend class Instruction; |
| 1382 | |
| 1383 | /// Clone an identical FCmpInst |
| 1384 | FCmpInst *cloneImpl() const; |
| 1385 | |
| 1386 | public: |
| 1387 | /// Constructor with insert-before-instruction semantics. |
| 1388 | FCmpInst( |
| 1389 | Instruction *InsertBefore, ///< Where to insert |
| 1390 | Predicate pred, ///< The predicate to use for the comparison |
| 1391 | Value *LHS, ///< The left-hand-side of the expression |
| 1392 | Value *RHS, ///< The right-hand-side of the expression |
| 1393 | const Twine &NameStr = "" ///< Name of the instruction |
| 1394 | ) : CmpInst(makeCmpResultType(LHS->getType()), |
| 1395 | Instruction::FCmp, pred, LHS, RHS, NameStr, |
| 1396 | InsertBefore) { |
| 1397 | AssertOK(); |
| 1398 | } |
| 1399 | |
| 1400 | /// Constructor with insert-at-end semantics. |
| 1401 | FCmpInst( |
| 1402 | BasicBlock &InsertAtEnd, ///< Block to insert into. |
| 1403 | Predicate pred, ///< The predicate to use for the comparison |
| 1404 | Value *LHS, ///< The left-hand-side of the expression |
| 1405 | Value *RHS, ///< The right-hand-side of the expression |
| 1406 | const Twine &NameStr = "" ///< Name of the instruction |
| 1407 | ) : CmpInst(makeCmpResultType(LHS->getType()), |
| 1408 | Instruction::FCmp, pred, LHS, RHS, NameStr, |
| 1409 | &InsertAtEnd) { |
| 1410 | AssertOK(); |
| 1411 | } |
| 1412 | |
| 1413 | /// Constructor with no-insertion semantics |
| 1414 | FCmpInst( |
| 1415 | Predicate Pred, ///< The predicate to use for the comparison |
| 1416 | Value *LHS, ///< The left-hand-side of the expression |
| 1417 | Value *RHS, ///< The right-hand-side of the expression |
| 1418 | const Twine &NameStr = "", ///< Name of the instruction |
| 1419 | Instruction *FlagsSource = nullptr |
| 1420 | ) : CmpInst(makeCmpResultType(LHS->getType()), Instruction::FCmp, Pred, LHS, |
| 1421 | RHS, NameStr, nullptr, FlagsSource) { |
| 1422 | AssertOK(); |
| 1423 | } |
| 1424 | |
| 1425 | /// @returns true if the predicate of this instruction is EQ or NE. |
| 1426 | /// Determine if this is an equality predicate. |
| 1427 | static bool isEquality(Predicate Pred) { |
| 1428 | return Pred == FCMP_OEQ || Pred == FCMP_ONE || Pred == FCMP_UEQ || |
| 1429 | Pred == FCMP_UNE; |
| 1430 | } |
| 1431 | |
| 1432 | /// @returns true if the predicate of this instruction is EQ or NE. |
| 1433 | /// Determine if this is an equality predicate. |
| 1434 | bool isEquality() const { return isEquality(getPredicate()); } |
| 1435 | |
| 1436 | /// @returns true if the predicate of this instruction is commutative. |
| 1437 | /// Determine if this is a commutative predicate. |
| 1438 | bool isCommutative() const { |
| 1439 | return isEquality() || |
| 1440 | getPredicate() == FCMP_FALSE || |
| 1441 | getPredicate() == FCMP_TRUE || |
| 1442 | getPredicate() == FCMP_ORD || |
| 1443 | getPredicate() == FCMP_UNO; |
| 1444 | } |
| 1445 | |
| 1446 | /// @returns true if the predicate is relational (not EQ or NE). |
| 1447 | /// Determine if this a relational predicate. |
| 1448 | bool isRelational() const { return !isEquality(); } |
| 1449 | |
| 1450 | /// Exchange the two operands to this instruction in such a way that it does |
| 1451 | /// not modify the semantics of the instruction. The predicate value may be |
| 1452 | /// changed to retain the same result if the predicate is order dependent |
| 1453 | /// (e.g. ult). |
| 1454 | /// Swap operands and adjust predicate. |
| 1455 | void swapOperands() { |
| 1456 | setPredicate(getSwappedPredicate()); |
| 1457 | Op<0>().swap(Op<1>()); |
| 1458 | } |
| 1459 | |
| 1460 | /// Methods for support type inquiry through isa, cast, and dyn_cast: |
| 1461 | static bool classof(const Instruction *I) { |
| 1462 | return I->getOpcode() == Instruction::FCmp; |
| 1463 | } |
| 1464 | static bool classof(const Value *V) { |
| 1465 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 1466 | } |
| 1467 | }; |
| 1468 | |
| 1469 | //===----------------------------------------------------------------------===// |
| 1470 | /// This class represents a function call, abstracting a target |
| 1471 | /// machine's calling convention. This class uses low bit of the SubClassData |
| 1472 | /// field to indicate whether or not this is a tail call. The rest of the bits |
| 1473 | /// hold the calling convention of the call. |
| 1474 | /// |
| 1475 | class CallInst : public CallBase { |
| 1476 | CallInst(const CallInst &CI); |
| 1477 | |
| 1478 | /// Construct a CallInst given a range of arguments. |
| 1479 | /// Construct a CallInst from a range of arguments |
| 1480 | inline CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args, |
| 1481 | ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr, |
| 1482 | Instruction *InsertBefore); |
| 1483 | |
| 1484 | inline CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args, |
| 1485 | const Twine &NameStr, Instruction *InsertBefore) |
| 1486 | : CallInst(Ty, Func, Args, None, NameStr, InsertBefore) {} |
| 1487 | |
| 1488 | /// Construct a CallInst given a range of arguments. |
| 1489 | /// Construct a CallInst from a range of arguments |
| 1490 | inline CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args, |
| 1491 | ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr, |
| 1492 | BasicBlock *InsertAtEnd); |
| 1493 | |
| 1494 | explicit CallInst(FunctionType *Ty, Value *F, const Twine &NameStr, |
| 1495 | Instruction *InsertBefore); |
| 1496 | |
| 1497 | CallInst(FunctionType *ty, Value *F, const Twine &NameStr, |
| 1498 | BasicBlock *InsertAtEnd); |
| 1499 | |
| 1500 | void init(FunctionType *FTy, Value *Func, ArrayRef<Value *> Args, |
| 1501 | ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr); |
| 1502 | void init(FunctionType *FTy, Value *Func, const Twine &NameStr); |
| 1503 | |
| 1504 | /// Compute the number of operands to allocate. |
| 1505 | static int ComputeNumOperands(int NumArgs, int NumBundleInputs = 0) { |
| 1506 | // We need one operand for the called function, plus the input operand |
| 1507 | // counts provided. |
| 1508 | return 1 + NumArgs + NumBundleInputs; |
| 1509 | } |
| 1510 | |
| 1511 | protected: |
| 1512 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 1513 | friend class Instruction; |
| 1514 | |
| 1515 | CallInst *cloneImpl() const; |
| 1516 | |
| 1517 | public: |
| 1518 | static CallInst *Create(FunctionType *Ty, Value *F, const Twine &NameStr = "", |
| 1519 | Instruction *InsertBefore = nullptr) { |
| 1520 | return new (ComputeNumOperands(0)) CallInst(Ty, F, NameStr, InsertBefore); |
| 1521 | } |
| 1522 | |
| 1523 | static CallInst *Create(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args, |
| 1524 | const Twine &NameStr, |
| 1525 | Instruction *InsertBefore = nullptr) { |
| 1526 | return new (ComputeNumOperands(Args.size())) |
| 1527 | CallInst(Ty, Func, Args, None, NameStr, InsertBefore); |
| 1528 | } |
| 1529 | |
| 1530 | static CallInst *Create(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args, |
| 1531 | ArrayRef<OperandBundleDef> Bundles = None, |
| 1532 | const Twine &NameStr = "", |
| 1533 | Instruction *InsertBefore = nullptr) { |
| 1534 | const int NumOperands = |
| 1535 | ComputeNumOperands(Args.size(), CountBundleInputs(Bundles)); |
| 1536 | const unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo); |
| 1537 | |
| 1538 | return new (NumOperands, DescriptorBytes) |
| 1539 | CallInst(Ty, Func, Args, Bundles, NameStr, InsertBefore); |
| 1540 | } |
| 1541 | |
| 1542 | static CallInst *Create(FunctionType *Ty, Value *F, const Twine &NameStr, |
| 1543 | BasicBlock *InsertAtEnd) { |
| 1544 | return new (ComputeNumOperands(0)) CallInst(Ty, F, NameStr, InsertAtEnd); |
| 1545 | } |
| 1546 | |
| 1547 | static CallInst *Create(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args, |
| 1548 | const Twine &NameStr, BasicBlock *InsertAtEnd) { |
| 1549 | return new (ComputeNumOperands(Args.size())) |
| 1550 | CallInst(Ty, Func, Args, None, NameStr, InsertAtEnd); |
| 1551 | } |
| 1552 | |
| 1553 | static CallInst *Create(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args, |
| 1554 | ArrayRef<OperandBundleDef> Bundles, |
| 1555 | const Twine &NameStr, BasicBlock *InsertAtEnd) { |
| 1556 | const int NumOperands = |
| 1557 | ComputeNumOperands(Args.size(), CountBundleInputs(Bundles)); |
| 1558 | const unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo); |
| 1559 | |
| 1560 | return new (NumOperands, DescriptorBytes) |
| 1561 | CallInst(Ty, Func, Args, Bundles, NameStr, InsertAtEnd); |
| 1562 | } |
| 1563 | |
| 1564 | static CallInst *Create(FunctionCallee Func, const Twine &NameStr = "", |
| 1565 | Instruction *InsertBefore = nullptr) { |
| 1566 | return Create(Func.getFunctionType(), Func.getCallee(), NameStr, |
| 1567 | InsertBefore); |
| 1568 | } |
| 1569 | |
| 1570 | static CallInst *Create(FunctionCallee Func, ArrayRef<Value *> Args, |
| 1571 | ArrayRef<OperandBundleDef> Bundles = None, |
| 1572 | const Twine &NameStr = "", |
| 1573 | Instruction *InsertBefore = nullptr) { |
| 1574 | return Create(Func.getFunctionType(), Func.getCallee(), Args, Bundles, |
| 1575 | NameStr, InsertBefore); |
| 1576 | } |
| 1577 | |
| 1578 | static CallInst *Create(FunctionCallee Func, ArrayRef<Value *> Args, |
| 1579 | const Twine &NameStr, |
| 1580 | Instruction *InsertBefore = nullptr) { |
| 1581 | return Create(Func.getFunctionType(), Func.getCallee(), Args, NameStr, |
| 1582 | InsertBefore); |
| 1583 | } |
| 1584 | |
| 1585 | static CallInst *Create(FunctionCallee Func, const Twine &NameStr, |
| 1586 | BasicBlock *InsertAtEnd) { |
| 1587 | return Create(Func.getFunctionType(), Func.getCallee(), NameStr, |
| 1588 | InsertAtEnd); |
| 1589 | } |
| 1590 | |
| 1591 | static CallInst *Create(FunctionCallee Func, ArrayRef<Value *> Args, |
| 1592 | const Twine &NameStr, BasicBlock *InsertAtEnd) { |
| 1593 | return Create(Func.getFunctionType(), Func.getCallee(), Args, NameStr, |
| 1594 | InsertAtEnd); |
| 1595 | } |
| 1596 | |
| 1597 | static CallInst *Create(FunctionCallee Func, ArrayRef<Value *> Args, |
| 1598 | ArrayRef<OperandBundleDef> Bundles, |
| 1599 | const Twine &NameStr, BasicBlock *InsertAtEnd) { |
| 1600 | return Create(Func.getFunctionType(), Func.getCallee(), Args, Bundles, |
| 1601 | NameStr, InsertAtEnd); |
| 1602 | } |
| 1603 | |
| 1604 | /// Create a clone of \p CI with a different set of operand bundles and |
| 1605 | /// insert it before \p InsertPt. |
| 1606 | /// |
| 1607 | /// The returned call instruction is identical \p CI in every way except that |
| 1608 | /// the operand bundles for the new instruction are set to the operand bundles |
| 1609 | /// in \p Bundles. |
| 1610 | static CallInst *Create(CallInst *CI, ArrayRef<OperandBundleDef> Bundles, |
| 1611 | Instruction *InsertPt = nullptr); |
| 1612 | |
| 1613 | /// Generate the IR for a call to malloc: |
| 1614 | /// 1. Compute the malloc call's argument as the specified type's size, |
| 1615 | /// possibly multiplied by the array size if the array size is not |
| 1616 | /// constant 1. |
| 1617 | /// 2. Call malloc with that argument. |
| 1618 | /// 3. Bitcast the result of the malloc call to the specified type. |
| 1619 | static Instruction *CreateMalloc(Instruction *InsertBefore, Type *IntPtrTy, |
| 1620 | Type *AllocTy, Value *AllocSize, |
| 1621 | Value *ArraySize = nullptr, |
| 1622 | Function *MallocF = nullptr, |
| 1623 | const Twine &Name = ""); |
| 1624 | static Instruction *CreateMalloc(BasicBlock *InsertAtEnd, Type *IntPtrTy, |
| 1625 | Type *AllocTy, Value *AllocSize, |
| 1626 | Value *ArraySize = nullptr, |
| 1627 | Function *MallocF = nullptr, |
| 1628 | const Twine &Name = ""); |
| 1629 | static Instruction *CreateMalloc(Instruction *InsertBefore, Type *IntPtrTy, |
| 1630 | Type *AllocTy, Value *AllocSize, |
| 1631 | Value *ArraySize = nullptr, |
| 1632 | ArrayRef<OperandBundleDef> Bundles = None, |
| 1633 | Function *MallocF = nullptr, |
| 1634 | const Twine &Name = ""); |
| 1635 | static Instruction *CreateMalloc(BasicBlock *InsertAtEnd, Type *IntPtrTy, |
| 1636 | Type *AllocTy, Value *AllocSize, |
| 1637 | Value *ArraySize = nullptr, |
| 1638 | ArrayRef<OperandBundleDef> Bundles = None, |
| 1639 | Function *MallocF = nullptr, |
| 1640 | const Twine &Name = ""); |
| 1641 | /// Generate the IR for a call to the builtin free function. |
| 1642 | static Instruction *CreateFree(Value *Source, Instruction *InsertBefore); |
| 1643 | static Instruction *CreateFree(Value *Source, BasicBlock *InsertAtEnd); |
| 1644 | static Instruction *CreateFree(Value *Source, |
| 1645 | ArrayRef<OperandBundleDef> Bundles, |
| 1646 | Instruction *InsertBefore); |
| 1647 | static Instruction *CreateFree(Value *Source, |
| 1648 | ArrayRef<OperandBundleDef> Bundles, |
| 1649 | BasicBlock *InsertAtEnd); |
| 1650 | |
| 1651 | // Note that 'musttail' implies 'tail'. |
| 1652 | enum TailCallKind : unsigned { |
| 1653 | TCK_None = 0, |
| 1654 | TCK_Tail = 1, |
| 1655 | TCK_MustTail = 2, |
| 1656 | TCK_NoTail = 3, |
| 1657 | TCK_LAST = TCK_NoTail |
| 1658 | }; |
| 1659 | |
| 1660 | using TailCallKindField = Bitfield::Element<TailCallKind, 0, 2, TCK_LAST>; |
| 1661 | static_assert( |
| 1662 | Bitfield::areContiguous<TailCallKindField, CallBase::CallingConvField>(), |
| 1663 | "Bitfields must be contiguous"); |
| 1664 | |
| 1665 | TailCallKind getTailCallKind() const { |
| 1666 | return getSubclassData<TailCallKindField>(); |
| 1667 | } |
| 1668 | |
| 1669 | bool isTailCall() const { |
| 1670 | TailCallKind Kind = getTailCallKind(); |
| 1671 | return Kind == TCK_Tail || Kind == TCK_MustTail; |
| 1672 | } |
| 1673 | |
| 1674 | bool isMustTailCall() const { return getTailCallKind() == TCK_MustTail; } |
| 1675 | |
| 1676 | bool isNoTailCall() const { return getTailCallKind() == TCK_NoTail; } |
| 1677 | |
| 1678 | void setTailCallKind(TailCallKind TCK) { |
| 1679 | setSubclassData<TailCallKindField>(TCK); |
| 1680 | } |
| 1681 | |
| 1682 | void setTailCall(bool IsTc = true) { |
| 1683 | setTailCallKind(IsTc ? TCK_Tail : TCK_None); |
| 1684 | } |
| 1685 | |
| 1686 | /// Return true if the call can return twice |
| 1687 | bool canReturnTwice() const { return hasFnAttr(Attribute::ReturnsTwice); } |
| 1688 | void setCanReturnTwice() { |
| 1689 | addAttribute(AttributeList::FunctionIndex, Attribute::ReturnsTwice); |
| 1690 | } |
| 1691 | |
| 1692 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 1693 | static bool classof(const Instruction *I) { |
| 1694 | return I->getOpcode() == Instruction::Call; |
| 1695 | } |
| 1696 | static bool classof(const Value *V) { |
| 1697 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 1698 | } |
| 1699 | |
| 1700 | /// Updates profile metadata by scaling it by \p S / \p T. |
| 1701 | void updateProfWeight(uint64_t S, uint64_t T); |
| 1702 | |
| 1703 | private: |
| 1704 | // Shadow Instruction::setInstructionSubclassData with a private forwarding |
| 1705 | // method so that subclasses cannot accidentally use it. |
| 1706 | template <typename Bitfield> |
| 1707 | void setSubclassData(typename Bitfield::Type Value) { |
| 1708 | Instruction::setSubclassData<Bitfield>(Value); |
| 1709 | } |
| 1710 | }; |
| 1711 | |
| 1712 | CallInst::CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args, |
| 1713 | ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr, |
| 1714 | BasicBlock *InsertAtEnd) |
| 1715 | : CallBase(Ty->getReturnType(), Instruction::Call, |
| 1716 | OperandTraits<CallBase>::op_end(this) - |
| 1717 | (Args.size() + CountBundleInputs(Bundles) + 1), |
| 1718 | unsigned(Args.size() + CountBundleInputs(Bundles) + 1), |
| 1719 | InsertAtEnd) { |
| 1720 | init(Ty, Func, Args, Bundles, NameStr); |
| 1721 | } |
| 1722 | |
| 1723 | CallInst::CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args, |
| 1724 | ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr, |
| 1725 | Instruction *InsertBefore) |
| 1726 | : CallBase(Ty->getReturnType(), Instruction::Call, |
| 1727 | OperandTraits<CallBase>::op_end(this) - |
| 1728 | (Args.size() + CountBundleInputs(Bundles) + 1), |
| 1729 | unsigned(Args.size() + CountBundleInputs(Bundles) + 1), |
| 1730 | InsertBefore) { |
| 1731 | init(Ty, Func, Args, Bundles, NameStr); |
| 1732 | } |
| 1733 | |
| 1734 | //===----------------------------------------------------------------------===// |
| 1735 | // SelectInst Class |
| 1736 | //===----------------------------------------------------------------------===// |
| 1737 | |
| 1738 | /// This class represents the LLVM 'select' instruction. |
| 1739 | /// |
| 1740 | class SelectInst : public Instruction { |
| 1741 | SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr, |
| 1742 | Instruction *InsertBefore) |
| 1743 | : Instruction(S1->getType(), Instruction::Select, |
| 1744 | &Op<0>(), 3, InsertBefore) { |
| 1745 | init(C, S1, S2); |
| 1746 | setName(NameStr); |
| 1747 | } |
| 1748 | |
| 1749 | SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr, |
| 1750 | BasicBlock *InsertAtEnd) |
| 1751 | : Instruction(S1->getType(), Instruction::Select, |
| 1752 | &Op<0>(), 3, InsertAtEnd) { |
| 1753 | init(C, S1, S2); |
| 1754 | setName(NameStr); |
| 1755 | } |
| 1756 | |
| 1757 | void init(Value *C, Value *S1, Value *S2) { |
| 1758 | assert(!areInvalidOperands(C, S1, S2) && "Invalid operands for select")((void)0); |
| 1759 | Op<0>() = C; |
| 1760 | Op<1>() = S1; |
| 1761 | Op<2>() = S2; |
| 1762 | } |
| 1763 | |
| 1764 | protected: |
| 1765 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 1766 | friend class Instruction; |
| 1767 | |
| 1768 | SelectInst *cloneImpl() const; |
| 1769 | |
| 1770 | public: |
| 1771 | static SelectInst *Create(Value *C, Value *S1, Value *S2, |
| 1772 | const Twine &NameStr = "", |
| 1773 | Instruction *InsertBefore = nullptr, |
| 1774 | Instruction *MDFrom = nullptr) { |
| 1775 | SelectInst *Sel = new(3) SelectInst(C, S1, S2, NameStr, InsertBefore); |
| 1776 | if (MDFrom) |
| 1777 | Sel->copyMetadata(*MDFrom); |
| 1778 | return Sel; |
| 1779 | } |
| 1780 | |
| 1781 | static SelectInst *Create(Value *C, Value *S1, Value *S2, |
| 1782 | const Twine &NameStr, |
| 1783 | BasicBlock *InsertAtEnd) { |
| 1784 | return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd); |
| 1785 | } |
| 1786 | |
| 1787 | const Value *getCondition() const { return Op<0>(); } |
| 1788 | const Value *getTrueValue() const { return Op<1>(); } |
| 1789 | const Value *getFalseValue() const { return Op<2>(); } |
| 1790 | Value *getCondition() { return Op<0>(); } |
| 1791 | Value *getTrueValue() { return Op<1>(); } |
| 1792 | Value *getFalseValue() { return Op<2>(); } |
| 1793 | |
| 1794 | void setCondition(Value *V) { Op<0>() = V; } |
| 1795 | void setTrueValue(Value *V) { Op<1>() = V; } |
| 1796 | void setFalseValue(Value *V) { Op<2>() = V; } |
| 1797 | |
| 1798 | /// Swap the true and false values of the select instruction. |
| 1799 | /// This doesn't swap prof metadata. |
| 1800 | void swapValues() { Op<1>().swap(Op<2>()); } |
| 1801 | |
| 1802 | /// Return a string if the specified operands are invalid |
| 1803 | /// for a select operation, otherwise return null. |
| 1804 | static const char *areInvalidOperands(Value *Cond, Value *True, Value *False); |
| 1805 | |
| 1806 | /// Transparently provide more efficient getOperand methods. |
| 1807 | DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void setOperand(unsigned, Value*); inline op_iterator op_begin(); inline const_op_iterator op_begin() const; inline op_iterator op_end(); inline const_op_iterator op_end() const; protected : template <int> inline Use &Op(); template <int > inline const Use &Op() const; public: inline unsigned getNumOperands() const; |
| 1808 | |
| 1809 | OtherOps getOpcode() const { |
| 1810 | return static_cast<OtherOps>(Instruction::getOpcode()); |
| 1811 | } |
| 1812 | |
| 1813 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 1814 | static bool classof(const Instruction *I) { |
| 1815 | return I->getOpcode() == Instruction::Select; |
| 1816 | } |
| 1817 | static bool classof(const Value *V) { |
| 1818 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 1819 | } |
| 1820 | }; |
| 1821 | |
| 1822 | template <> |
| 1823 | struct OperandTraits<SelectInst> : public FixedNumOperandTraits<SelectInst, 3> { |
| 1824 | }; |
| 1825 | |
| 1826 | DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)SelectInst::op_iterator SelectInst::op_begin() { return OperandTraits <SelectInst>::op_begin(this); } SelectInst::const_op_iterator SelectInst::op_begin() const { return OperandTraits<SelectInst >::op_begin(const_cast<SelectInst*>(this)); } SelectInst ::op_iterator SelectInst::op_end() { return OperandTraits< SelectInst>::op_end(this); } SelectInst::const_op_iterator SelectInst::op_end() const { return OperandTraits<SelectInst >::op_end(const_cast<SelectInst*>(this)); } Value *SelectInst ::getOperand(unsigned i_nocapture) const { ((void)0); return cast_or_null <Value>( OperandTraits<SelectInst>::op_begin(const_cast <SelectInst*>(this))[i_nocapture].get()); } void SelectInst ::setOperand(unsigned i_nocapture, Value *Val_nocapture) { (( void)0); OperandTraits<SelectInst>::op_begin(this)[i_nocapture ] = Val_nocapture; } unsigned SelectInst::getNumOperands() const { return OperandTraits<SelectInst>::operands(this); } template <int Idx_nocapture> Use &SelectInst::Op() { return this->OpFrom<Idx_nocapture>(this); } template <int Idx_nocapture> const Use &SelectInst::Op() const { return this->OpFrom<Idx_nocapture>(this); } |
| 1827 | |
| 1828 | //===----------------------------------------------------------------------===// |
| 1829 | // VAArgInst Class |
| 1830 | //===----------------------------------------------------------------------===// |
| 1831 | |
| 1832 | /// This class represents the va_arg llvm instruction, which returns |
| 1833 | /// an argument of the specified type given a va_list and increments that list |
| 1834 | /// |
| 1835 | class VAArgInst : public UnaryInstruction { |
| 1836 | protected: |
| 1837 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 1838 | friend class Instruction; |
| 1839 | |
| 1840 | VAArgInst *cloneImpl() const; |
| 1841 | |
| 1842 | public: |
| 1843 | VAArgInst(Value *List, Type *Ty, const Twine &NameStr = "", |
| 1844 | Instruction *InsertBefore = nullptr) |
| 1845 | : UnaryInstruction(Ty, VAArg, List, InsertBefore) { |
| 1846 | setName(NameStr); |
| 1847 | } |
| 1848 | |
| 1849 | VAArgInst(Value *List, Type *Ty, const Twine &NameStr, |
| 1850 | BasicBlock *InsertAtEnd) |
| 1851 | : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) { |
| 1852 | setName(NameStr); |
| 1853 | } |
| 1854 | |
| 1855 | Value *getPointerOperand() { return getOperand(0); } |
| 1856 | const Value *getPointerOperand() const { return getOperand(0); } |
| 1857 | static unsigned getPointerOperandIndex() { return 0U; } |
| 1858 | |
| 1859 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 1860 | static bool classof(const Instruction *I) { |
| 1861 | return I->getOpcode() == VAArg; |
| 1862 | } |
| 1863 | static bool classof(const Value *V) { |
| 1864 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 1865 | } |
| 1866 | }; |
| 1867 | |
| 1868 | //===----------------------------------------------------------------------===// |
| 1869 | // ExtractElementInst Class |
| 1870 | //===----------------------------------------------------------------------===// |
| 1871 | |
| 1872 | /// This instruction extracts a single (scalar) |
| 1873 | /// element from a VectorType value |
| 1874 | /// |
| 1875 | class ExtractElementInst : public Instruction { |
| 1876 | ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr = "", |
| 1877 | Instruction *InsertBefore = nullptr); |
| 1878 | ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr, |
| 1879 | BasicBlock *InsertAtEnd); |
| 1880 | |
| 1881 | protected: |
| 1882 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 1883 | friend class Instruction; |
| 1884 | |
| 1885 | ExtractElementInst *cloneImpl() const; |
| 1886 | |
| 1887 | public: |
| 1888 | static ExtractElementInst *Create(Value *Vec, Value *Idx, |
| 1889 | const Twine &NameStr = "", |
| 1890 | Instruction *InsertBefore = nullptr) { |
| 1891 | return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertBefore); |
| 1892 | } |
| 1893 | |
| 1894 | static ExtractElementInst *Create(Value *Vec, Value *Idx, |
| 1895 | const Twine &NameStr, |
| 1896 | BasicBlock *InsertAtEnd) { |
| 1897 | return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertAtEnd); |
| 1898 | } |
| 1899 | |
| 1900 | /// Return true if an extractelement instruction can be |
| 1901 | /// formed with the specified operands. |
| 1902 | static bool isValidOperands(const Value *Vec, const Value *Idx); |
| 1903 | |
| 1904 | Value *getVectorOperand() { return Op<0>(); } |
| 1905 | Value *getIndexOperand() { return Op<1>(); } |
| 1906 | const Value *getVectorOperand() const { return Op<0>(); } |
| 1907 | const Value *getIndexOperand() const { return Op<1>(); } |
| 1908 | |
| 1909 | VectorType *getVectorOperandType() const { |
| 1910 | return cast<VectorType>(getVectorOperand()->getType()); |
| 1911 | } |
| 1912 | |
| 1913 | /// Transparently provide more efficient getOperand methods. |
| 1914 | DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void setOperand(unsigned, Value*); inline op_iterator op_begin(); inline const_op_iterator op_begin() const; inline op_iterator op_end(); inline const_op_iterator op_end() const; protected : template <int> inline Use &Op(); template <int > inline const Use &Op() const; public: inline unsigned getNumOperands() const; |
| 1915 | |
| 1916 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 1917 | static bool classof(const Instruction *I) { |
| 1918 | return I->getOpcode() == Instruction::ExtractElement; |
| 1919 | } |
| 1920 | static bool classof(const Value *V) { |
| 1921 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 1922 | } |
| 1923 | }; |
| 1924 | |
| 1925 | template <> |
| 1926 | struct OperandTraits<ExtractElementInst> : |
| 1927 | public FixedNumOperandTraits<ExtractElementInst, 2> { |
| 1928 | }; |
| 1929 | |
| 1930 | DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)ExtractElementInst::op_iterator ExtractElementInst::op_begin( ) { return OperandTraits<ExtractElementInst>::op_begin( this); } ExtractElementInst::const_op_iterator ExtractElementInst ::op_begin() const { return OperandTraits<ExtractElementInst >::op_begin(const_cast<ExtractElementInst*>(this)); } ExtractElementInst::op_iterator ExtractElementInst::op_end() { return OperandTraits<ExtractElementInst>::op_end(this ); } ExtractElementInst::const_op_iterator ExtractElementInst ::op_end() const { return OperandTraits<ExtractElementInst >::op_end(const_cast<ExtractElementInst*>(this)); } Value *ExtractElementInst::getOperand(unsigned i_nocapture) const { ((void)0); return cast_or_null<Value>( OperandTraits< ExtractElementInst>::op_begin(const_cast<ExtractElementInst *>(this))[i_nocapture].get()); } void ExtractElementInst:: setOperand(unsigned i_nocapture, Value *Val_nocapture) { ((void )0); OperandTraits<ExtractElementInst>::op_begin(this)[ i_nocapture] = Val_nocapture; } unsigned ExtractElementInst:: getNumOperands() const { return OperandTraits<ExtractElementInst >::operands(this); } template <int Idx_nocapture> Use &ExtractElementInst::Op() { return this->OpFrom<Idx_nocapture >(this); } template <int Idx_nocapture> const Use & ExtractElementInst::Op() const { return this->OpFrom<Idx_nocapture >(this); } |
| 1931 | |
| 1932 | //===----------------------------------------------------------------------===// |
| 1933 | // InsertElementInst Class |
| 1934 | //===----------------------------------------------------------------------===// |
| 1935 | |
| 1936 | /// This instruction inserts a single (scalar) |
| 1937 | /// element into a VectorType value |
| 1938 | /// |
| 1939 | class InsertElementInst : public Instruction { |
| 1940 | InsertElementInst(Value *Vec, Value *NewElt, Value *Idx, |
| 1941 | const Twine &NameStr = "", |
| 1942 | Instruction *InsertBefore = nullptr); |
| 1943 | InsertElementInst(Value *Vec, Value *NewElt, Value *Idx, const Twine &NameStr, |
| 1944 | BasicBlock *InsertAtEnd); |
| 1945 | |
| 1946 | protected: |
| 1947 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 1948 | friend class Instruction; |
| 1949 | |
| 1950 | InsertElementInst *cloneImpl() const; |
| 1951 | |
| 1952 | public: |
| 1953 | static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx, |
| 1954 | const Twine &NameStr = "", |
| 1955 | Instruction *InsertBefore = nullptr) { |
| 1956 | return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore); |
| 1957 | } |
| 1958 | |
| 1959 | static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx, |
| 1960 | const Twine &NameStr, |
| 1961 | BasicBlock *InsertAtEnd) { |
| 1962 | return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd); |
| 1963 | } |
| 1964 | |
| 1965 | /// Return true if an insertelement instruction can be |
| 1966 | /// formed with the specified operands. |
| 1967 | static bool isValidOperands(const Value *Vec, const Value *NewElt, |
| 1968 | const Value *Idx); |
| 1969 | |
| 1970 | /// Overload to return most specific vector type. |
| 1971 | /// |
| 1972 | VectorType *getType() const { |
| 1973 | return cast<VectorType>(Instruction::getType()); |
| 1974 | } |
| 1975 | |
| 1976 | /// Transparently provide more efficient getOperand methods. |
| 1977 | DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void setOperand(unsigned, Value*); inline op_iterator op_begin(); inline const_op_iterator op_begin() const; inline op_iterator op_end(); inline const_op_iterator op_end() const; protected : template <int> inline Use &Op(); template <int > inline const Use &Op() const; public: inline unsigned getNumOperands() const; |
| 1978 | |
| 1979 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 1980 | static bool classof(const Instruction *I) { |
| 1981 | return I->getOpcode() == Instruction::InsertElement; |
| 1982 | } |
| 1983 | static bool classof(const Value *V) { |
| 1984 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 1985 | } |
| 1986 | }; |
| 1987 | |
| 1988 | template <> |
| 1989 | struct OperandTraits<InsertElementInst> : |
| 1990 | public FixedNumOperandTraits<InsertElementInst, 3> { |
| 1991 | }; |
| 1992 | |
| 1993 | DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)InsertElementInst::op_iterator InsertElementInst::op_begin() { return OperandTraits<InsertElementInst>::op_begin(this ); } InsertElementInst::const_op_iterator InsertElementInst:: op_begin() const { return OperandTraits<InsertElementInst> ::op_begin(const_cast<InsertElementInst*>(this)); } InsertElementInst ::op_iterator InsertElementInst::op_end() { return OperandTraits <InsertElementInst>::op_end(this); } InsertElementInst:: const_op_iterator InsertElementInst::op_end() const { return OperandTraits <InsertElementInst>::op_end(const_cast<InsertElementInst *>(this)); } Value *InsertElementInst::getOperand(unsigned i_nocapture) const { ((void)0); return cast_or_null<Value >( OperandTraits<InsertElementInst>::op_begin(const_cast <InsertElementInst*>(this))[i_nocapture].get()); } void InsertElementInst::setOperand(unsigned i_nocapture, Value *Val_nocapture ) { ((void)0); OperandTraits<InsertElementInst>::op_begin (this)[i_nocapture] = Val_nocapture; } unsigned InsertElementInst ::getNumOperands() const { return OperandTraits<InsertElementInst >::operands(this); } template <int Idx_nocapture> Use &InsertElementInst::Op() { return this->OpFrom<Idx_nocapture >(this); } template <int Idx_nocapture> const Use & InsertElementInst::Op() const { return this->OpFrom<Idx_nocapture >(this); } |
| 1994 | |
| 1995 | //===----------------------------------------------------------------------===// |
| 1996 | // ShuffleVectorInst Class |
| 1997 | //===----------------------------------------------------------------------===// |
| 1998 | |
| 1999 | constexpr int UndefMaskElem = -1; |
| 2000 | |
| 2001 | /// This instruction constructs a fixed permutation of two |
| 2002 | /// input vectors. |
| 2003 | /// |
| 2004 | /// For each element of the result vector, the shuffle mask selects an element |
| 2005 | /// from one of the input vectors to copy to the result. Non-negative elements |
| 2006 | /// in the mask represent an index into the concatenated pair of input vectors. |
| 2007 | /// UndefMaskElem (-1) specifies that the result element is undefined. |
| 2008 | /// |
| 2009 | /// For scalable vectors, all the elements of the mask must be 0 or -1. This |
| 2010 | /// requirement may be relaxed in the future. |
| 2011 | class ShuffleVectorInst : public Instruction { |
| 2012 | SmallVector<int, 4> ShuffleMask; |
| 2013 | Constant *ShuffleMaskForBitcode; |
| 2014 | |
| 2015 | protected: |
| 2016 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 2017 | friend class Instruction; |
| 2018 | |
| 2019 | ShuffleVectorInst *cloneImpl() const; |
| 2020 | |
| 2021 | public: |
| 2022 | ShuffleVectorInst(Value *V1, Value *V2, Value *Mask, |
| 2023 | const Twine &NameStr = "", |
| 2024 | Instruction *InsertBefor = nullptr); |
| 2025 | ShuffleVectorInst(Value *V1, Value *V2, Value *Mask, |
| 2026 | const Twine &NameStr, BasicBlock *InsertAtEnd); |
| 2027 | ShuffleVectorInst(Value *V1, Value *V2, ArrayRef<int> Mask, |
| 2028 | const Twine &NameStr = "", |
| 2029 | Instruction *InsertBefor = nullptr); |
| 2030 | ShuffleVectorInst(Value *V1, Value *V2, ArrayRef<int> Mask, |
| 2031 | const Twine &NameStr, BasicBlock *InsertAtEnd); |
| 2032 | |
| 2033 | void *operator new(size_t S) { return User::operator new(S, 2); } |
| 2034 | void operator delete(void *Ptr) { return User::operator delete(Ptr); } |
| 2035 | |
| 2036 | /// Swap the operands and adjust the mask to preserve the semantics |
| 2037 | /// of the instruction. |
| 2038 | void commute(); |
| 2039 | |
| 2040 | /// Return true if a shufflevector instruction can be |
| 2041 | /// formed with the specified operands. |
| 2042 | static bool isValidOperands(const Value *V1, const Value *V2, |
| 2043 | const Value *Mask); |
| 2044 | static bool isValidOperands(const Value *V1, const Value *V2, |
| 2045 | ArrayRef<int> Mask); |
| 2046 | |
| 2047 | /// Overload to return most specific vector type. |
| 2048 | /// |
| 2049 | VectorType *getType() const { |
| 2050 | return cast<VectorType>(Instruction::getType()); |
| 2051 | } |
| 2052 | |
| 2053 | /// Transparently provide more efficient getOperand methods. |
| 2054 | DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void setOperand(unsigned, Value*); inline op_iterator op_begin(); inline const_op_iterator op_begin() const; inline op_iterator op_end(); inline const_op_iterator op_end() const; protected : template <int> inline Use &Op(); template <int > inline const Use &Op() const; public: inline unsigned getNumOperands() const; |
| 2055 | |
| 2056 | /// Return the shuffle mask value of this instruction for the given element |
| 2057 | /// index. Return UndefMaskElem if the element is undef. |
| 2058 | int getMaskValue(unsigned Elt) const { return ShuffleMask[Elt]; } |
| 2059 | |
| 2060 | /// Convert the input shuffle mask operand to a vector of integers. Undefined |
| 2061 | /// elements of the mask are returned as UndefMaskElem. |
| 2062 | static void getShuffleMask(const Constant *Mask, |
| 2063 | SmallVectorImpl<int> &Result); |
| 2064 | |
| 2065 | /// Return the mask for this instruction as a vector of integers. Undefined |
| 2066 | /// elements of the mask are returned as UndefMaskElem. |
| 2067 | void getShuffleMask(SmallVectorImpl<int> &Result) const { |
| 2068 | Result.assign(ShuffleMask.begin(), ShuffleMask.end()); |
| 2069 | } |
| 2070 | |
| 2071 | /// Return the mask for this instruction, for use in bitcode. |
| 2072 | /// |
| 2073 | /// TODO: This is temporary until we decide a new bitcode encoding for |
| 2074 | /// shufflevector. |
| 2075 | Constant *getShuffleMaskForBitcode() const { return ShuffleMaskForBitcode; } |
| 2076 | |
| 2077 | static Constant *convertShuffleMaskForBitcode(ArrayRef<int> Mask, |
| 2078 | Type *ResultTy); |
| 2079 | |
| 2080 | void setShuffleMask(ArrayRef<int> Mask); |
| 2081 | |
| 2082 | ArrayRef<int> getShuffleMask() const { return ShuffleMask; } |
| 2083 | |
| 2084 | /// Return true if this shuffle returns a vector with a different number of |
| 2085 | /// elements than its source vectors. |
| 2086 | /// Examples: shufflevector <4 x n> A, <4 x n> B, <1,2,3> |
| 2087 | /// shufflevector <4 x n> A, <4 x n> B, <1,2,3,4,5> |
| 2088 | bool changesLength() const { |
| 2089 | unsigned NumSourceElts = cast<VectorType>(Op<0>()->getType()) |
| 2090 | ->getElementCount() |
| 2091 | .getKnownMinValue(); |
| 2092 | unsigned NumMaskElts = ShuffleMask.size(); |
| 2093 | return NumSourceElts != NumMaskElts; |
| 2094 | } |
| 2095 | |
| 2096 | /// Return true if this shuffle returns a vector with a greater number of |
| 2097 | /// elements than its source vectors. |
| 2098 | /// Example: shufflevector <2 x n> A, <2 x n> B, <1,2,3> |
| 2099 | bool increasesLength() const { |
| 2100 | unsigned NumSourceElts = cast<VectorType>(Op<0>()->getType()) |
| 2101 | ->getElementCount() |
| 2102 | .getKnownMinValue(); |
| 2103 | unsigned NumMaskElts = ShuffleMask.size(); |
| 2104 | return NumSourceElts < NumMaskElts; |
| 2105 | } |
| 2106 | |
| 2107 | /// Return true if this shuffle mask chooses elements from exactly one source |
| 2108 | /// vector. |
| 2109 | /// Example: <7,5,undef,7> |
| 2110 | /// This assumes that vector operands are the same length as the mask. |
| 2111 | static bool isSingleSourceMask(ArrayRef<int> Mask); |
| 2112 | static bool isSingleSourceMask(const Constant *Mask) { |
| 2113 | assert(Mask->getType()->isVectorTy() && "Shuffle needs vector constant.")((void)0); |
| 2114 | SmallVector<int, 16> MaskAsInts; |
| 2115 | getShuffleMask(Mask, MaskAsInts); |
| 2116 | return isSingleSourceMask(MaskAsInts); |
| 2117 | } |
| 2118 | |
| 2119 | /// Return true if this shuffle chooses elements from exactly one source |
| 2120 | /// vector without changing the length of that vector. |
| 2121 | /// Example: shufflevector <4 x n> A, <4 x n> B, <3,0,undef,3> |
| 2122 | /// TODO: Optionally allow length-changing shuffles. |
| 2123 | bool isSingleSource() const { |
| 2124 | return !changesLength() && isSingleSourceMask(ShuffleMask); |
| 2125 | } |
| 2126 | |
| 2127 | /// Return true if this shuffle mask chooses elements from exactly one source |
| 2128 | /// vector without lane crossings. A shuffle using this mask is not |
| 2129 | /// necessarily a no-op because it may change the number of elements from its |
| 2130 | /// input vectors or it may provide demanded bits knowledge via undef lanes. |
| 2131 | /// Example: <undef,undef,2,3> |
| 2132 | static bool isIdentityMask(ArrayRef<int> Mask); |
| 2133 | static bool isIdentityMask(const Constant *Mask) { |
| 2134 | assert(Mask->getType()->isVectorTy() && "Shuffle needs vector constant.")((void)0); |
| 2135 | SmallVector<int, 16> MaskAsInts; |
| 2136 | getShuffleMask(Mask, MaskAsInts); |
| 2137 | return isIdentityMask(MaskAsInts); |
| 2138 | } |
| 2139 | |
| 2140 | /// Return true if this shuffle chooses elements from exactly one source |
| 2141 | /// vector without lane crossings and does not change the number of elements |
| 2142 | /// from its input vectors. |
| 2143 | /// Example: shufflevector <4 x n> A, <4 x n> B, <4,undef,6,undef> |
| 2144 | bool isIdentity() const { |
| 2145 | return !changesLength() && isIdentityMask(ShuffleMask); |
| 2146 | } |
| 2147 | |
| 2148 | /// Return true if this shuffle lengthens exactly one source vector with |
| 2149 | /// undefs in the high elements. |
| 2150 | bool isIdentityWithPadding() const; |
| 2151 | |
| 2152 | /// Return true if this shuffle extracts the first N elements of exactly one |
| 2153 | /// source vector. |
| 2154 | bool isIdentityWithExtract() const; |
| 2155 | |
| 2156 | /// Return true if this shuffle concatenates its 2 source vectors. This |
| 2157 | /// returns false if either input is undefined. In that case, the shuffle is |
| 2158 | /// is better classified as an identity with padding operation. |
| 2159 | bool isConcat() const; |
| 2160 | |
| 2161 | /// Return true if this shuffle mask chooses elements from its source vectors |
| 2162 | /// without lane crossings. A shuffle using this mask would be |
| 2163 | /// equivalent to a vector select with a constant condition operand. |
| 2164 | /// Example: <4,1,6,undef> |
| 2165 | /// This returns false if the mask does not choose from both input vectors. |
| 2166 | /// In that case, the shuffle is better classified as an identity shuffle. |
| 2167 | /// This assumes that vector operands are the same length as the mask |
| 2168 | /// (a length-changing shuffle can never be equivalent to a vector select). |
| 2169 | static bool isSelectMask(ArrayRef<int> Mask); |
| 2170 | static bool isSelectMask(const Constant *Mask) { |
| 2171 | assert(Mask->getType()->isVectorTy() && "Shuffle needs vector constant.")((void)0); |
| 2172 | SmallVector<int, 16> MaskAsInts; |
| 2173 | getShuffleMask(Mask, MaskAsInts); |
| 2174 | return isSelectMask(MaskAsInts); |
| 2175 | } |
| 2176 | |
| 2177 | /// Return true if this shuffle chooses elements from its source vectors |
| 2178 | /// without lane crossings and all operands have the same number of elements. |
| 2179 | /// In other words, this shuffle is equivalent to a vector select with a |
| 2180 | /// constant condition operand. |
| 2181 | /// Example: shufflevector <4 x n> A, <4 x n> B, <undef,1,6,3> |
| 2182 | /// This returns false if the mask does not choose from both input vectors. |
| 2183 | /// In that case, the shuffle is better classified as an identity shuffle. |
| 2184 | /// TODO: Optionally allow length-changing shuffles. |
| 2185 | bool isSelect() const { |
| 2186 | return !changesLength() && isSelectMask(ShuffleMask); |
| 2187 | } |
| 2188 | |
| 2189 | /// Return true if this shuffle mask swaps the order of elements from exactly |
| 2190 | /// one source vector. |
| 2191 | /// Example: <7,6,undef,4> |
| 2192 | /// This assumes that vector operands are the same length as the mask. |
| 2193 | static bool isReverseMask(ArrayRef<int> Mask); |
| 2194 | static bool isReverseMask(const Constant *Mask) { |
| 2195 | assert(Mask->getType()->isVectorTy() && "Shuffle needs vector constant.")((void)0); |
| 2196 | SmallVector<int, 16> MaskAsInts; |
| 2197 | getShuffleMask(Mask, MaskAsInts); |
| 2198 | return isReverseMask(MaskAsInts); |
| 2199 | } |
| 2200 | |
| 2201 | /// Return true if this shuffle swaps the order of elements from exactly |
| 2202 | /// one source vector. |
| 2203 | /// Example: shufflevector <4 x n> A, <4 x n> B, <3,undef,1,undef> |
| 2204 | /// TODO: Optionally allow length-changing shuffles. |
| 2205 | bool isReverse() const { |
| 2206 | return !changesLength() && isReverseMask(ShuffleMask); |
| 2207 | } |
| 2208 | |
| 2209 | /// Return true if this shuffle mask chooses all elements with the same value |
| 2210 | /// as the first element of exactly one source vector. |
| 2211 | /// Example: <4,undef,undef,4> |
| 2212 | /// This assumes that vector operands are the same length as the mask. |
| 2213 | static bool isZeroEltSplatMask(ArrayRef<int> Mask); |
| 2214 | static bool isZeroEltSplatMask(const Constant *Mask) { |
| 2215 | assert(Mask->getType()->isVectorTy() && "Shuffle needs vector constant.")((void)0); |
| 2216 | SmallVector<int, 16> MaskAsInts; |
| 2217 | getShuffleMask(Mask, MaskAsInts); |
| 2218 | return isZeroEltSplatMask(MaskAsInts); |
| 2219 | } |
| 2220 | |
| 2221 | /// Return true if all elements of this shuffle are the same value as the |
| 2222 | /// first element of exactly one source vector without changing the length |
| 2223 | /// of that vector. |
| 2224 | /// Example: shufflevector <4 x n> A, <4 x n> B, <undef,0,undef,0> |
| 2225 | /// TODO: Optionally allow length-changing shuffles. |
| 2226 | /// TODO: Optionally allow splats from other elements. |
| 2227 | bool isZeroEltSplat() const { |
| 2228 | return !changesLength() && isZeroEltSplatMask(ShuffleMask); |
| 2229 | } |
| 2230 | |
| 2231 | /// Return true if this shuffle mask is a transpose mask. |
| 2232 | /// Transpose vector masks transpose a 2xn matrix. They read corresponding |
| 2233 | /// even- or odd-numbered vector elements from two n-dimensional source |
| 2234 | /// vectors and write each result into consecutive elements of an |
| 2235 | /// n-dimensional destination vector. Two shuffles are necessary to complete |
| 2236 | /// the transpose, one for the even elements and another for the odd elements. |
| 2237 | /// This description closely follows how the TRN1 and TRN2 AArch64 |
| 2238 | /// instructions operate. |
| 2239 | /// |
| 2240 | /// For example, a simple 2x2 matrix can be transposed with: |
| 2241 | /// |
| 2242 | /// ; Original matrix |
| 2243 | /// m0 = < a, b > |
| 2244 | /// m1 = < c, d > |
| 2245 | /// |
| 2246 | /// ; Transposed matrix |
| 2247 | /// t0 = < a, c > = shufflevector m0, m1, < 0, 2 > |
| 2248 | /// t1 = < b, d > = shufflevector m0, m1, < 1, 3 > |
| 2249 | /// |
| 2250 | /// For matrices having greater than n columns, the resulting nx2 transposed |
| 2251 | /// matrix is stored in two result vectors such that one vector contains |
| 2252 | /// interleaved elements from all the even-numbered rows and the other vector |
| 2253 | /// contains interleaved elements from all the odd-numbered rows. For example, |
| 2254 | /// a 2x4 matrix can be transposed with: |
| 2255 | /// |
| 2256 | /// ; Original matrix |
| 2257 | /// m0 = < a, b, c, d > |
| 2258 | /// m1 = < e, f, g, h > |
| 2259 | /// |
| 2260 | /// ; Transposed matrix |
| 2261 | /// t0 = < a, e, c, g > = shufflevector m0, m1 < 0, 4, 2, 6 > |
| 2262 | /// t1 = < b, f, d, h > = shufflevector m0, m1 < 1, 5, 3, 7 > |
| 2263 | static bool isTransposeMask(ArrayRef<int> Mask); |
| 2264 | static bool isTransposeMask(const Constant *Mask) { |
| 2265 | assert(Mask->getType()->isVectorTy() && "Shuffle needs vector constant.")((void)0); |
| 2266 | SmallVector<int, 16> MaskAsInts; |
| 2267 | getShuffleMask(Mask, MaskAsInts); |
| 2268 | return isTransposeMask(MaskAsInts); |
| 2269 | } |
| 2270 | |
| 2271 | /// Return true if this shuffle transposes the elements of its inputs without |
| 2272 | /// changing the length of the vectors. This operation may also be known as a |
| 2273 | /// merge or interleave. See the description for isTransposeMask() for the |
| 2274 | /// exact specification. |
| 2275 | /// Example: shufflevector <4 x n> A, <4 x n> B, <0,4,2,6> |
| 2276 | bool isTranspose() const { |
| 2277 | return !changesLength() && isTransposeMask(ShuffleMask); |
| 2278 | } |
| 2279 | |
| 2280 | /// Return true if this shuffle mask is an extract subvector mask. |
| 2281 | /// A valid extract subvector mask returns a smaller vector from a single |
| 2282 | /// source operand. The base extraction index is returned as well. |
| 2283 | static bool isExtractSubvectorMask(ArrayRef<int> Mask, int NumSrcElts, |
| 2284 | int &Index); |
| 2285 | static bool isExtractSubvectorMask(const Constant *Mask, int NumSrcElts, |
| 2286 | int &Index) { |
| 2287 | assert(Mask->getType()->isVectorTy() && "Shuffle needs vector constant.")((void)0); |
| 2288 | // Not possible to express a shuffle mask for a scalable vector for this |
| 2289 | // case. |
| 2290 | if (isa<ScalableVectorType>(Mask->getType())) |
| 2291 | return false; |
| 2292 | SmallVector<int, 16> MaskAsInts; |
| 2293 | getShuffleMask(Mask, MaskAsInts); |
| 2294 | return isExtractSubvectorMask(MaskAsInts, NumSrcElts, Index); |
| 2295 | } |
| 2296 | |
| 2297 | /// Return true if this shuffle mask is an extract subvector mask. |
| 2298 | bool isExtractSubvectorMask(int &Index) const { |
| 2299 | // Not possible to express a shuffle mask for a scalable vector for this |
| 2300 | // case. |
| 2301 | if (isa<ScalableVectorType>(getType())) |
| 2302 | return false; |
| 2303 | |
| 2304 | int NumSrcElts = |
| 2305 | cast<FixedVectorType>(Op<0>()->getType())->getNumElements(); |
| 2306 | return isExtractSubvectorMask(ShuffleMask, NumSrcElts, Index); |
| 2307 | } |
| 2308 | |
| 2309 | /// Change values in a shuffle permute mask assuming the two vector operands |
| 2310 | /// of length InVecNumElts have swapped position. |
| 2311 | static void commuteShuffleMask(MutableArrayRef<int> Mask, |
| 2312 | unsigned InVecNumElts) { |
| 2313 | for (int &Idx : Mask) { |
| 2314 | if (Idx == -1) |
| 2315 | continue; |
| 2316 | Idx = Idx < (int)InVecNumElts ? Idx + InVecNumElts : Idx - InVecNumElts; |
| 2317 | assert(Idx >= 0 && Idx < (int)InVecNumElts * 2 &&((void)0) |
| 2318 | "shufflevector mask index out of range")((void)0); |
| 2319 | } |
| 2320 | } |
| 2321 | |
| 2322 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 2323 | static bool classof(const Instruction *I) { |
| 2324 | return I->getOpcode() == Instruction::ShuffleVector; |
| 2325 | } |
| 2326 | static bool classof(const Value *V) { |
| 2327 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 2328 | } |
| 2329 | }; |
| 2330 | |
| 2331 | template <> |
| 2332 | struct OperandTraits<ShuffleVectorInst> |
| 2333 | : public FixedNumOperandTraits<ShuffleVectorInst, 2> {}; |
| 2334 | |
| 2335 | DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)ShuffleVectorInst::op_iterator ShuffleVectorInst::op_begin() { return OperandTraits<ShuffleVectorInst>::op_begin(this ); } ShuffleVectorInst::const_op_iterator ShuffleVectorInst:: op_begin() const { return OperandTraits<ShuffleVectorInst> ::op_begin(const_cast<ShuffleVectorInst*>(this)); } ShuffleVectorInst ::op_iterator ShuffleVectorInst::op_end() { return OperandTraits <ShuffleVectorInst>::op_end(this); } ShuffleVectorInst:: const_op_iterator ShuffleVectorInst::op_end() const { return OperandTraits <ShuffleVectorInst>::op_end(const_cast<ShuffleVectorInst *>(this)); } Value *ShuffleVectorInst::getOperand(unsigned i_nocapture) const { ((void)0); return cast_or_null<Value >( OperandTraits<ShuffleVectorInst>::op_begin(const_cast <ShuffleVectorInst*>(this))[i_nocapture].get()); } void ShuffleVectorInst::setOperand(unsigned i_nocapture, Value *Val_nocapture ) { ((void)0); OperandTraits<ShuffleVectorInst>::op_begin (this)[i_nocapture] = Val_nocapture; } unsigned ShuffleVectorInst ::getNumOperands() const { return OperandTraits<ShuffleVectorInst >::operands(this); } template <int Idx_nocapture> Use &ShuffleVectorInst::Op() { return this->OpFrom<Idx_nocapture >(this); } template <int Idx_nocapture> const Use & ShuffleVectorInst::Op() const { return this->OpFrom<Idx_nocapture >(this); } |
| 2336 | |
| 2337 | //===----------------------------------------------------------------------===// |
| 2338 | // ExtractValueInst Class |
| 2339 | //===----------------------------------------------------------------------===// |
| 2340 | |
| 2341 | /// This instruction extracts a struct member or array |
| 2342 | /// element value from an aggregate value. |
| 2343 | /// |
| 2344 | class ExtractValueInst : public UnaryInstruction { |
| 2345 | SmallVector<unsigned, 4> Indices; |
| 2346 | |
| 2347 | ExtractValueInst(const ExtractValueInst &EVI); |
| 2348 | |
| 2349 | /// Constructors - Create a extractvalue instruction with a base aggregate |
| 2350 | /// value and a list of indices. The first ctor can optionally insert before |
| 2351 | /// an existing instruction, the second appends the new instruction to the |
| 2352 | /// specified BasicBlock. |
| 2353 | inline ExtractValueInst(Value *Agg, |
| 2354 | ArrayRef<unsigned> Idxs, |
| 2355 | const Twine &NameStr, |
| 2356 | Instruction *InsertBefore); |
| 2357 | inline ExtractValueInst(Value *Agg, |
| 2358 | ArrayRef<unsigned> Idxs, |
| 2359 | const Twine &NameStr, BasicBlock *InsertAtEnd); |
| 2360 | |
| 2361 | void init(ArrayRef<unsigned> Idxs, const Twine &NameStr); |
| 2362 | |
| 2363 | protected: |
| 2364 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 2365 | friend class Instruction; |
| 2366 | |
| 2367 | ExtractValueInst *cloneImpl() const; |
| 2368 | |
| 2369 | public: |
| 2370 | static ExtractValueInst *Create(Value *Agg, |
| 2371 | ArrayRef<unsigned> Idxs, |
| 2372 | const Twine &NameStr = "", |
| 2373 | Instruction *InsertBefore = nullptr) { |
| 2374 | return new |
| 2375 | ExtractValueInst(Agg, Idxs, NameStr, InsertBefore); |
| 2376 | } |
| 2377 | |
| 2378 | static ExtractValueInst *Create(Value *Agg, |
| 2379 | ArrayRef<unsigned> Idxs, |
| 2380 | const Twine &NameStr, |
| 2381 | BasicBlock *InsertAtEnd) { |
| 2382 | return new ExtractValueInst(Agg, Idxs, NameStr, InsertAtEnd); |
| 2383 | } |
| 2384 | |
| 2385 | /// Returns the type of the element that would be extracted |
| 2386 | /// with an extractvalue instruction with the specified parameters. |
| 2387 | /// |
| 2388 | /// Null is returned if the indices are invalid for the specified type. |
| 2389 | static Type *getIndexedType(Type *Agg, ArrayRef<unsigned> Idxs); |
| 2390 | |
| 2391 | using idx_iterator = const unsigned*; |
| 2392 | |
| 2393 | inline idx_iterator idx_begin() const { return Indices.begin(); } |
| 2394 | inline idx_iterator idx_end() const { return Indices.end(); } |
| 2395 | inline iterator_range<idx_iterator> indices() const { |
| 2396 | return make_range(idx_begin(), idx_end()); |
| 2397 | } |
| 2398 | |
| 2399 | Value *getAggregateOperand() { |
| 2400 | return getOperand(0); |
| 2401 | } |
| 2402 | const Value *getAggregateOperand() const { |
| 2403 | return getOperand(0); |
| 2404 | } |
| 2405 | static unsigned getAggregateOperandIndex() { |
| 2406 | return 0U; // get index for modifying correct operand |
| 2407 | } |
| 2408 | |
| 2409 | ArrayRef<unsigned> getIndices() const { |
| 2410 | return Indices; |
| 2411 | } |
| 2412 | |
| 2413 | unsigned getNumIndices() const { |
| 2414 | return (unsigned)Indices.size(); |
| 2415 | } |
| 2416 | |
| 2417 | bool hasIndices() const { |
| 2418 | return true; |
| 2419 | } |
| 2420 | |
| 2421 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 2422 | static bool classof(const Instruction *I) { |
| 2423 | return I->getOpcode() == Instruction::ExtractValue; |
| 2424 | } |
| 2425 | static bool classof(const Value *V) { |
| 2426 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 2427 | } |
| 2428 | }; |
| 2429 | |
| 2430 | ExtractValueInst::ExtractValueInst(Value *Agg, |
| 2431 | ArrayRef<unsigned> Idxs, |
| 2432 | const Twine &NameStr, |
| 2433 | Instruction *InsertBefore) |
| 2434 | : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)), |
| 2435 | ExtractValue, Agg, InsertBefore) { |
| 2436 | init(Idxs, NameStr); |
| 2437 | } |
| 2438 | |
| 2439 | ExtractValueInst::ExtractValueInst(Value *Agg, |
| 2440 | ArrayRef<unsigned> Idxs, |
| 2441 | const Twine &NameStr, |
| 2442 | BasicBlock *InsertAtEnd) |
| 2443 | : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)), |
| 2444 | ExtractValue, Agg, InsertAtEnd) { |
| 2445 | init(Idxs, NameStr); |
| 2446 | } |
| 2447 | |
| 2448 | //===----------------------------------------------------------------------===// |
| 2449 | // InsertValueInst Class |
| 2450 | //===----------------------------------------------------------------------===// |
| 2451 | |
| 2452 | /// This instruction inserts a struct field of array element |
| 2453 | /// value into an aggregate value. |
| 2454 | /// |
| 2455 | class InsertValueInst : public Instruction { |
| 2456 | SmallVector<unsigned, 4> Indices; |
| 2457 | |
| 2458 | InsertValueInst(const InsertValueInst &IVI); |
| 2459 | |
| 2460 | /// Constructors - Create a insertvalue instruction with a base aggregate |
| 2461 | /// value, a value to insert, and a list of indices. The first ctor can |
| 2462 | /// optionally insert before an existing instruction, the second appends |
| 2463 | /// the new instruction to the specified BasicBlock. |
| 2464 | inline InsertValueInst(Value *Agg, Value *Val, |
| 2465 | ArrayRef<unsigned> Idxs, |
| 2466 | const Twine &NameStr, |
| 2467 | Instruction *InsertBefore); |
| 2468 | inline InsertValueInst(Value *Agg, Value *Val, |
| 2469 | ArrayRef<unsigned> Idxs, |
| 2470 | const Twine &NameStr, BasicBlock *InsertAtEnd); |
| 2471 | |
| 2472 | /// Constructors - These two constructors are convenience methods because one |
| 2473 | /// and two index insertvalue instructions are so common. |
| 2474 | InsertValueInst(Value *Agg, Value *Val, unsigned Idx, |
| 2475 | const Twine &NameStr = "", |
| 2476 | Instruction *InsertBefore = nullptr); |
| 2477 | InsertValueInst(Value *Agg, Value *Val, unsigned Idx, const Twine &NameStr, |
| 2478 | BasicBlock *InsertAtEnd); |
| 2479 | |
| 2480 | void init(Value *Agg, Value *Val, ArrayRef<unsigned> Idxs, |
| 2481 | const Twine &NameStr); |
| 2482 | |
| 2483 | protected: |
| 2484 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 2485 | friend class Instruction; |
| 2486 | |
| 2487 | InsertValueInst *cloneImpl() const; |
| 2488 | |
| 2489 | public: |
| 2490 | // allocate space for exactly two operands |
| 2491 | void *operator new(size_t S) { return User::operator new(S, 2); } |
| 2492 | void operator delete(void *Ptr) { User::operator delete(Ptr); } |
| 2493 | |
| 2494 | static InsertValueInst *Create(Value *Agg, Value *Val, |
| 2495 | ArrayRef<unsigned> Idxs, |
| 2496 | const Twine &NameStr = "", |
| 2497 | Instruction *InsertBefore = nullptr) { |
| 2498 | return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertBefore); |
| 2499 | } |
| 2500 | |
| 2501 | static InsertValueInst *Create(Value *Agg, Value *Val, |
| 2502 | ArrayRef<unsigned> Idxs, |
| 2503 | const Twine &NameStr, |
| 2504 | BasicBlock *InsertAtEnd) { |
| 2505 | return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertAtEnd); |
| 2506 | } |
| 2507 | |
| 2508 | /// Transparently provide more efficient getOperand methods. |
| 2509 | DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void setOperand(unsigned, Value*); inline op_iterator op_begin(); inline const_op_iterator op_begin() const; inline op_iterator op_end(); inline const_op_iterator op_end() const; protected : template <int> inline Use &Op(); template <int > inline const Use &Op() const; public: inline unsigned getNumOperands() const; |
| 2510 | |
| 2511 | using idx_iterator = const unsigned*; |
| 2512 | |
| 2513 | inline idx_iterator idx_begin() const { return Indices.begin(); } |
| 2514 | inline idx_iterator idx_end() const { return Indices.end(); } |
| 2515 | inline iterator_range<idx_iterator> indices() const { |
| 2516 | return make_range(idx_begin(), idx_end()); |
| 2517 | } |
| 2518 | |
| 2519 | Value *getAggregateOperand() { |
| 2520 | return getOperand(0); |
| 2521 | } |
| 2522 | const Value *getAggregateOperand() const { |
| 2523 | return getOperand(0); |
| 2524 | } |
| 2525 | static unsigned getAggregateOperandIndex() { |
| 2526 | return 0U; // get index for modifying correct operand |
| 2527 | } |
| 2528 | |
| 2529 | Value *getInsertedValueOperand() { |
| 2530 | return getOperand(1); |
| 2531 | } |
| 2532 | const Value *getInsertedValueOperand() const { |
| 2533 | return getOperand(1); |
| 2534 | } |
| 2535 | static unsigned getInsertedValueOperandIndex() { |
| 2536 | return 1U; // get index for modifying correct operand |
| 2537 | } |
| 2538 | |
| 2539 | ArrayRef<unsigned> getIndices() const { |
| 2540 | return Indices; |
| 2541 | } |
| 2542 | |
| 2543 | unsigned getNumIndices() const { |
| 2544 | return (unsigned)Indices.size(); |
| 2545 | } |
| 2546 | |
| 2547 | bool hasIndices() const { |
| 2548 | return true; |
| 2549 | } |
| 2550 | |
| 2551 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 2552 | static bool classof(const Instruction *I) { |
| 2553 | return I->getOpcode() == Instruction::InsertValue; |
| 2554 | } |
| 2555 | static bool classof(const Value *V) { |
| 2556 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 2557 | } |
| 2558 | }; |
| 2559 | |
| 2560 | template <> |
| 2561 | struct OperandTraits<InsertValueInst> : |
| 2562 | public FixedNumOperandTraits<InsertValueInst, 2> { |
| 2563 | }; |
| 2564 | |
| 2565 | InsertValueInst::InsertValueInst(Value *Agg, |
| 2566 | Value *Val, |
| 2567 | ArrayRef<unsigned> Idxs, |
| 2568 | const Twine &NameStr, |
| 2569 | Instruction *InsertBefore) |
| 2570 | : Instruction(Agg->getType(), InsertValue, |
| 2571 | OperandTraits<InsertValueInst>::op_begin(this), |
| 2572 | 2, InsertBefore) { |
| 2573 | init(Agg, Val, Idxs, NameStr); |
| 2574 | } |
| 2575 | |
| 2576 | InsertValueInst::InsertValueInst(Value *Agg, |
| 2577 | Value *Val, |
| 2578 | ArrayRef<unsigned> Idxs, |
| 2579 | const Twine &NameStr, |
| 2580 | BasicBlock *InsertAtEnd) |
| 2581 | : Instruction(Agg->getType(), InsertValue, |
| 2582 | OperandTraits<InsertValueInst>::op_begin(this), |
| 2583 | 2, InsertAtEnd) { |
| 2584 | init(Agg, Val, Idxs, NameStr); |
| 2585 | } |
| 2586 | |
| 2587 | DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)InsertValueInst::op_iterator InsertValueInst::op_begin() { return OperandTraits<InsertValueInst>::op_begin(this); } InsertValueInst ::const_op_iterator InsertValueInst::op_begin() const { return OperandTraits<InsertValueInst>::op_begin(const_cast< InsertValueInst*>(this)); } InsertValueInst::op_iterator InsertValueInst ::op_end() { return OperandTraits<InsertValueInst>::op_end (this); } InsertValueInst::const_op_iterator InsertValueInst:: op_end() const { return OperandTraits<InsertValueInst>:: op_end(const_cast<InsertValueInst*>(this)); } Value *InsertValueInst ::getOperand(unsigned i_nocapture) const { ((void)0); return cast_or_null <Value>( OperandTraits<InsertValueInst>::op_begin (const_cast<InsertValueInst*>(this))[i_nocapture].get() ); } void InsertValueInst::setOperand(unsigned i_nocapture, Value *Val_nocapture) { ((void)0); OperandTraits<InsertValueInst >::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned InsertValueInst::getNumOperands() const { return OperandTraits <InsertValueInst>::operands(this); } template <int Idx_nocapture > Use &InsertValueInst::Op() { return this->OpFrom< Idx_nocapture>(this); } template <int Idx_nocapture> const Use &InsertValueInst::Op() const { return this-> OpFrom<Idx_nocapture>(this); } |
| 2588 | |
| 2589 | //===----------------------------------------------------------------------===// |
| 2590 | // PHINode Class |
| 2591 | //===----------------------------------------------------------------------===// |
| 2592 | |
| 2593 | // PHINode - The PHINode class is used to represent the magical mystical PHI |
| 2594 | // node, that can not exist in nature, but can be synthesized in a computer |
| 2595 | // scientist's overactive imagination. |
| 2596 | // |
| 2597 | class PHINode : public Instruction { |
| 2598 | /// The number of operands actually allocated. NumOperands is |
| 2599 | /// the number actually in use. |
| 2600 | unsigned ReservedSpace; |
| 2601 | |
| 2602 | PHINode(const PHINode &PN); |
| 2603 | |
| 2604 | explicit PHINode(Type *Ty, unsigned NumReservedValues, |
| 2605 | const Twine &NameStr = "", |
| 2606 | Instruction *InsertBefore = nullptr) |
| 2607 | : Instruction(Ty, Instruction::PHI, nullptr, 0, InsertBefore), |
| 2608 | ReservedSpace(NumReservedValues) { |
| 2609 | assert(!Ty->isTokenTy() && "PHI nodes cannot have token type!")((void)0); |
| 2610 | setName(NameStr); |
| 2611 | allocHungoffUses(ReservedSpace); |
| 2612 | } |
| 2613 | |
| 2614 | PHINode(Type *Ty, unsigned NumReservedValues, const Twine &NameStr, |
| 2615 | BasicBlock *InsertAtEnd) |
| 2616 | : Instruction(Ty, Instruction::PHI, nullptr, 0, InsertAtEnd), |
| 2617 | ReservedSpace(NumReservedValues) { |
| 2618 | assert(!Ty->isTokenTy() && "PHI nodes cannot have token type!")((void)0); |
| 2619 | setName(NameStr); |
| 2620 | allocHungoffUses(ReservedSpace); |
| 2621 | } |
| 2622 | |
| 2623 | protected: |
| 2624 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 2625 | friend class Instruction; |
| 2626 | |
| 2627 | PHINode *cloneImpl() const; |
| 2628 | |
| 2629 | // allocHungoffUses - this is more complicated than the generic |
| 2630 | // User::allocHungoffUses, because we have to allocate Uses for the incoming |
| 2631 | // values and pointers to the incoming blocks, all in one allocation. |
| 2632 | void allocHungoffUses(unsigned N) { |
| 2633 | User::allocHungoffUses(N, /* IsPhi */ true); |
| 2634 | } |
| 2635 | |
| 2636 | public: |
| 2637 | /// Constructors - NumReservedValues is a hint for the number of incoming |
| 2638 | /// edges that this phi node will have (use 0 if you really have no idea). |
| 2639 | static PHINode *Create(Type *Ty, unsigned NumReservedValues, |
| 2640 | const Twine &NameStr = "", |
| 2641 | Instruction *InsertBefore = nullptr) { |
| 2642 | return new PHINode(Ty, NumReservedValues, NameStr, InsertBefore); |
| 2643 | } |
| 2644 | |
| 2645 | static PHINode *Create(Type *Ty, unsigned NumReservedValues, |
| 2646 | const Twine &NameStr, BasicBlock *InsertAtEnd) { |
| 2647 | return new PHINode(Ty, NumReservedValues, NameStr, InsertAtEnd); |
| 2648 | } |
| 2649 | |
| 2650 | /// Provide fast operand accessors |
| 2651 | DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void setOperand(unsigned, Value*); inline op_iterator op_begin(); inline const_op_iterator op_begin() const; inline op_iterator op_end(); inline const_op_iterator op_end() const; protected : template <int> inline Use &Op(); template <int > inline const Use &Op() const; public: inline unsigned getNumOperands() const; |
| 2652 | |
| 2653 | // Block iterator interface. This provides access to the list of incoming |
| 2654 | // basic blocks, which parallels the list of incoming values. |
| 2655 | |
| 2656 | using block_iterator = BasicBlock **; |
| 2657 | using const_block_iterator = BasicBlock * const *; |
| 2658 | |
| 2659 | block_iterator block_begin() { |
| 2660 | return reinterpret_cast<block_iterator>(op_begin() + ReservedSpace); |
| 2661 | } |
| 2662 | |
| 2663 | const_block_iterator block_begin() const { |
| 2664 | return reinterpret_cast<const_block_iterator>(op_begin() + ReservedSpace); |
| 2665 | } |
| 2666 | |
| 2667 | block_iterator block_end() { |
| 2668 | return block_begin() + getNumOperands(); |
| 2669 | } |
| 2670 | |
| 2671 | const_block_iterator block_end() const { |
| 2672 | return block_begin() + getNumOperands(); |
| 2673 | } |
| 2674 | |
| 2675 | iterator_range<block_iterator> blocks() { |
| 2676 | return make_range(block_begin(), block_end()); |
| 2677 | } |
| 2678 | |
| 2679 | iterator_range<const_block_iterator> blocks() const { |
| 2680 | return make_range(block_begin(), block_end()); |
| 2681 | } |
| 2682 | |
| 2683 | op_range incoming_values() { return operands(); } |
| 2684 | |
| 2685 | const_op_range incoming_values() const { return operands(); } |
| 2686 | |
| 2687 | /// Return the number of incoming edges |
| 2688 | /// |
| 2689 | unsigned getNumIncomingValues() const { return getNumOperands(); } |
| 2690 | |
| 2691 | /// Return incoming value number x |
| 2692 | /// |
| 2693 | Value *getIncomingValue(unsigned i) const { |
| 2694 | return getOperand(i); |
| 2695 | } |
| 2696 | void setIncomingValue(unsigned i, Value *V) { |
| 2697 | assert(V && "PHI node got a null value!")((void)0); |
| 2698 | assert(getType() == V->getType() &&((void)0) |
| 2699 | "All operands to PHI node must be the same type as the PHI node!")((void)0); |
| 2700 | setOperand(i, V); |
| 2701 | } |
| 2702 | |
| 2703 | static unsigned getOperandNumForIncomingValue(unsigned i) { |
| 2704 | return i; |
| 2705 | } |
| 2706 | |
| 2707 | static unsigned getIncomingValueNumForOperand(unsigned i) { |
| 2708 | return i; |
| 2709 | } |
| 2710 | |
| 2711 | /// Return incoming basic block number @p i. |
| 2712 | /// |
| 2713 | BasicBlock *getIncomingBlock(unsigned i) const { |
| 2714 | return block_begin()[i]; |
| 2715 | } |
| 2716 | |
| 2717 | /// Return incoming basic block corresponding |
| 2718 | /// to an operand of the PHI. |
| 2719 | /// |
| 2720 | BasicBlock *getIncomingBlock(const Use &U) const { |
| 2721 | assert(this == U.getUser() && "Iterator doesn't point to PHI's Uses?")((void)0); |
| 2722 | return getIncomingBlock(unsigned(&U - op_begin())); |
| 2723 | } |
| 2724 | |
| 2725 | /// Return incoming basic block corresponding |
| 2726 | /// to value use iterator. |
| 2727 | /// |
| 2728 | BasicBlock *getIncomingBlock(Value::const_user_iterator I) const { |
| 2729 | return getIncomingBlock(I.getUse()); |
| 2730 | } |
| 2731 | |
| 2732 | void setIncomingBlock(unsigned i, BasicBlock *BB) { |
| 2733 | assert(BB && "PHI node got a null basic block!")((void)0); |
| 2734 | block_begin()[i] = BB; |
| 2735 | } |
| 2736 | |
| 2737 | /// Replace every incoming basic block \p Old to basic block \p New. |
| 2738 | void replaceIncomingBlockWith(const BasicBlock *Old, BasicBlock *New) { |
| 2739 | assert(New && Old && "PHI node got a null basic block!")((void)0); |
| 2740 | for (unsigned Op = 0, NumOps = getNumOperands(); Op != NumOps; ++Op) |
| 2741 | if (getIncomingBlock(Op) == Old) |
| 2742 | setIncomingBlock(Op, New); |
| 2743 | } |
| 2744 | |
| 2745 | /// Add an incoming value to the end of the PHI list |
| 2746 | /// |
| 2747 | void addIncoming(Value *V, BasicBlock *BB) { |
| 2748 | if (getNumOperands() == ReservedSpace) |
| 2749 | growOperands(); // Get more space! |
| 2750 | // Initialize some new operands. |
| 2751 | setNumHungOffUseOperands(getNumOperands() + 1); |
| 2752 | setIncomingValue(getNumOperands() - 1, V); |
| 2753 | setIncomingBlock(getNumOperands() - 1, BB); |
| 2754 | } |
| 2755 | |
| 2756 | /// Remove an incoming value. This is useful if a |
| 2757 | /// predecessor basic block is deleted. The value removed is returned. |
| 2758 | /// |
| 2759 | /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty |
| 2760 | /// is true), the PHI node is destroyed and any uses of it are replaced with |
| 2761 | /// dummy values. The only time there should be zero incoming values to a PHI |
| 2762 | /// node is when the block is dead, so this strategy is sound. |
| 2763 | /// |
| 2764 | Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true); |
| 2765 | |
| 2766 | Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) { |
| 2767 | int Idx = getBasicBlockIndex(BB); |
| 2768 | assert(Idx >= 0 && "Invalid basic block argument to remove!")((void)0); |
| 2769 | return removeIncomingValue(Idx, DeletePHIIfEmpty); |
| 2770 | } |
| 2771 | |
| 2772 | /// Return the first index of the specified basic |
| 2773 | /// block in the value list for this PHI. Returns -1 if no instance. |
| 2774 | /// |
| 2775 | int getBasicBlockIndex(const BasicBlock *BB) const { |
| 2776 | for (unsigned i = 0, e = getNumOperands(); i != e; ++i) |
| 2777 | if (block_begin()[i] == BB) |
| 2778 | return i; |
| 2779 | return -1; |
| 2780 | } |
| 2781 | |
| 2782 | Value *getIncomingValueForBlock(const BasicBlock *BB) const { |
| 2783 | int Idx = getBasicBlockIndex(BB); |
| 2784 | assert(Idx >= 0 && "Invalid basic block argument!")((void)0); |
| 2785 | return getIncomingValue(Idx); |
| 2786 | } |
| 2787 | |
| 2788 | /// Set every incoming value(s) for block \p BB to \p V. |
| 2789 | void setIncomingValueForBlock(const BasicBlock *BB, Value *V) { |
| 2790 | assert(BB && "PHI node got a null basic block!")((void)0); |
| 2791 | bool Found = false; |
| 2792 | for (unsigned Op = 0, NumOps = getNumOperands(); Op != NumOps; ++Op) |
| 2793 | if (getIncomingBlock(Op) == BB) { |
| 2794 | Found = true; |
| 2795 | setIncomingValue(Op, V); |
| 2796 | } |
| 2797 | (void)Found; |
| 2798 | assert(Found && "Invalid basic block argument to set!")((void)0); |
| 2799 | } |
| 2800 | |
| 2801 | /// If the specified PHI node always merges together the |
| 2802 | /// same value, return the value, otherwise return null. |
| 2803 | Value *hasConstantValue() const; |
| 2804 | |
| 2805 | /// Whether the specified PHI node always merges |
| 2806 | /// together the same value, assuming undefs are equal to a unique |
| 2807 | /// non-undef value. |
| 2808 | bool hasConstantOrUndefValue() const; |
| 2809 | |
| 2810 | /// If the PHI node is complete which means all of its parent's predecessors |
| 2811 | /// have incoming value in this PHI, return true, otherwise return false. |
| 2812 | bool isComplete() const { |
| 2813 | return llvm::all_of(predecessors(getParent()), |
| 2814 | [this](const BasicBlock *Pred) { |
| 2815 | return getBasicBlockIndex(Pred) >= 0; |
| 2816 | }); |
| 2817 | } |
| 2818 | |
| 2819 | /// Methods for support type inquiry through isa, cast, and dyn_cast: |
| 2820 | static bool classof(const Instruction *I) { |
| 2821 | return I->getOpcode() == Instruction::PHI; |
| 2822 | } |
| 2823 | static bool classof(const Value *V) { |
| 2824 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 2825 | } |
| 2826 | |
| 2827 | private: |
| 2828 | void growOperands(); |
| 2829 | }; |
| 2830 | |
| 2831 | template <> |
| 2832 | struct OperandTraits<PHINode> : public HungoffOperandTraits<2> { |
| 2833 | }; |
| 2834 | |
| 2835 | DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)PHINode::op_iterator PHINode::op_begin() { return OperandTraits <PHINode>::op_begin(this); } PHINode::const_op_iterator PHINode::op_begin() const { return OperandTraits<PHINode> ::op_begin(const_cast<PHINode*>(this)); } PHINode::op_iterator PHINode::op_end() { return OperandTraits<PHINode>::op_end (this); } PHINode::const_op_iterator PHINode::op_end() const { return OperandTraits<PHINode>::op_end(const_cast<PHINode *>(this)); } Value *PHINode::getOperand(unsigned i_nocapture ) const { ((void)0); return cast_or_null<Value>( OperandTraits <PHINode>::op_begin(const_cast<PHINode*>(this))[i_nocapture ].get()); } void PHINode::setOperand(unsigned i_nocapture, Value *Val_nocapture) { ((void)0); OperandTraits<PHINode>::op_begin (this)[i_nocapture] = Val_nocapture; } unsigned PHINode::getNumOperands () const { return OperandTraits<PHINode>::operands(this ); } template <int Idx_nocapture> Use &PHINode::Op( ) { return this->OpFrom<Idx_nocapture>(this); } template <int Idx_nocapture> const Use &PHINode::Op() const { return this->OpFrom<Idx_nocapture>(this); } |
| 2836 | |
| 2837 | //===----------------------------------------------------------------------===// |
| 2838 | // LandingPadInst Class |
| 2839 | //===----------------------------------------------------------------------===// |
| 2840 | |
| 2841 | //===--------------------------------------------------------------------------- |
| 2842 | /// The landingpad instruction holds all of the information |
| 2843 | /// necessary to generate correct exception handling. The landingpad instruction |
| 2844 | /// cannot be moved from the top of a landing pad block, which itself is |
| 2845 | /// accessible only from the 'unwind' edge of an invoke. This uses the |
| 2846 | /// SubclassData field in Value to store whether or not the landingpad is a |
| 2847 | /// cleanup. |
| 2848 | /// |
| 2849 | class LandingPadInst : public Instruction { |
| 2850 | using CleanupField = BoolBitfieldElementT<0>; |
| 2851 | |
| 2852 | /// The number of operands actually allocated. NumOperands is |
| 2853 | /// the number actually in use. |
| 2854 | unsigned ReservedSpace; |
| 2855 | |
| 2856 | LandingPadInst(const LandingPadInst &LP); |
| 2857 | |
| 2858 | public: |
| 2859 | enum ClauseType { Catch, Filter }; |
| 2860 | |
| 2861 | private: |
| 2862 | explicit LandingPadInst(Type *RetTy, unsigned NumReservedValues, |
| 2863 | const Twine &NameStr, Instruction *InsertBefore); |
| 2864 | explicit LandingPadInst(Type *RetTy, unsigned NumReservedValues, |
| 2865 | const Twine &NameStr, BasicBlock *InsertAtEnd); |
| 2866 | |
| 2867 | // Allocate space for exactly zero operands. |
| 2868 | void *operator new(size_t S) { return User::operator new(S); } |
| 2869 | |
| 2870 | void growOperands(unsigned Size); |
| 2871 | void init(unsigned NumReservedValues, const Twine &NameStr); |
| 2872 | |
| 2873 | protected: |
| 2874 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 2875 | friend class Instruction; |
| 2876 | |
| 2877 | LandingPadInst *cloneImpl() const; |
| 2878 | |
| 2879 | public: |
| 2880 | void operator delete(void *Ptr) { User::operator delete(Ptr); } |
| 2881 | |
| 2882 | /// Constructors - NumReservedClauses is a hint for the number of incoming |
| 2883 | /// clauses that this landingpad will have (use 0 if you really have no idea). |
| 2884 | static LandingPadInst *Create(Type *RetTy, unsigned NumReservedClauses, |
| 2885 | const Twine &NameStr = "", |
| 2886 | Instruction *InsertBefore = nullptr); |
| 2887 | static LandingPadInst *Create(Type *RetTy, unsigned NumReservedClauses, |
| 2888 | const Twine &NameStr, BasicBlock *InsertAtEnd); |
| 2889 | |
| 2890 | /// Provide fast operand accessors |
| 2891 | DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void setOperand(unsigned, Value*); inline op_iterator op_begin(); inline const_op_iterator op_begin() const; inline op_iterator op_end(); inline const_op_iterator op_end() const; protected : template <int> inline Use &Op(); template <int > inline const Use &Op() const; public: inline unsigned getNumOperands() const; |
| 2892 | |
| 2893 | /// Return 'true' if this landingpad instruction is a |
| 2894 | /// cleanup. I.e., it should be run when unwinding even if its landing pad |
| 2895 | /// doesn't catch the exception. |
| 2896 | bool isCleanup() const { return getSubclassData<CleanupField>(); } |
| 2897 | |
| 2898 | /// Indicate that this landingpad instruction is a cleanup. |
| 2899 | void setCleanup(bool V) { setSubclassData<CleanupField>(V); } |
| 2900 | |
| 2901 | /// Add a catch or filter clause to the landing pad. |
| 2902 | void addClause(Constant *ClauseVal); |
| 2903 | |
| 2904 | /// Get the value of the clause at index Idx. Use isCatch/isFilter to |
| 2905 | /// determine what type of clause this is. |
| 2906 | Constant *getClause(unsigned Idx) const { |
| 2907 | return cast<Constant>(getOperandList()[Idx]); |
| 2908 | } |
| 2909 | |
| 2910 | /// Return 'true' if the clause and index Idx is a catch clause. |
| 2911 | bool isCatch(unsigned Idx) const { |
| 2912 | return !isa<ArrayType>(getOperandList()[Idx]->getType()); |
| 2913 | } |
| 2914 | |
| 2915 | /// Return 'true' if the clause and index Idx is a filter clause. |
| 2916 | bool isFilter(unsigned Idx) const { |
| 2917 | return isa<ArrayType>(getOperandList()[Idx]->getType()); |
| 2918 | } |
| 2919 | |
| 2920 | /// Get the number of clauses for this landing pad. |
| 2921 | unsigned getNumClauses() const { return getNumOperands(); } |
| 2922 | |
| 2923 | /// Grow the size of the operand list to accommodate the new |
| 2924 | /// number of clauses. |
| 2925 | void reserveClauses(unsigned Size) { growOperands(Size); } |
| 2926 | |
| 2927 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 2928 | static bool classof(const Instruction *I) { |
| 2929 | return I->getOpcode() == Instruction::LandingPad; |
| 2930 | } |
| 2931 | static bool classof(const Value *V) { |
| 2932 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 2933 | } |
| 2934 | }; |
| 2935 | |
| 2936 | template <> |
| 2937 | struct OperandTraits<LandingPadInst> : public HungoffOperandTraits<1> { |
| 2938 | }; |
| 2939 | |
| 2940 | DEFINE_TRANSPARENT_OPERAND_ACCESSORS(LandingPadInst, Value)LandingPadInst::op_iterator LandingPadInst::op_begin() { return OperandTraits<LandingPadInst>::op_begin(this); } LandingPadInst ::const_op_iterator LandingPadInst::op_begin() const { return OperandTraits<LandingPadInst>::op_begin(const_cast< LandingPadInst*>(this)); } LandingPadInst::op_iterator LandingPadInst ::op_end() { return OperandTraits<LandingPadInst>::op_end (this); } LandingPadInst::const_op_iterator LandingPadInst::op_end () const { return OperandTraits<LandingPadInst>::op_end (const_cast<LandingPadInst*>(this)); } Value *LandingPadInst ::getOperand(unsigned i_nocapture) const { ((void)0); return cast_or_null <Value>( OperandTraits<LandingPadInst>::op_begin( const_cast<LandingPadInst*>(this))[i_nocapture].get()); } void LandingPadInst::setOperand(unsigned i_nocapture, Value *Val_nocapture) { ((void)0); OperandTraits<LandingPadInst >::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned LandingPadInst::getNumOperands() const { return OperandTraits <LandingPadInst>::operands(this); } template <int Idx_nocapture > Use &LandingPadInst::Op() { return this->OpFrom< Idx_nocapture>(this); } template <int Idx_nocapture> const Use &LandingPadInst::Op() const { return this-> OpFrom<Idx_nocapture>(this); } |
| 2941 | |
| 2942 | //===----------------------------------------------------------------------===// |
| 2943 | // ReturnInst Class |
| 2944 | //===----------------------------------------------------------------------===// |
| 2945 | |
| 2946 | //===--------------------------------------------------------------------------- |
| 2947 | /// Return a value (possibly void), from a function. Execution |
| 2948 | /// does not continue in this function any longer. |
| 2949 | /// |
| 2950 | class ReturnInst : public Instruction { |
| 2951 | ReturnInst(const ReturnInst &RI); |
| 2952 | |
| 2953 | private: |
| 2954 | // ReturnInst constructors: |
| 2955 | // ReturnInst() - 'ret void' instruction |
| 2956 | // ReturnInst( null) - 'ret void' instruction |
| 2957 | // ReturnInst(Value* X) - 'ret X' instruction |
| 2958 | // ReturnInst( null, Inst *I) - 'ret void' instruction, insert before I |
| 2959 | // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I |
| 2960 | // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of B |
| 2961 | // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of B |
| 2962 | // |
| 2963 | // NOTE: If the Value* passed is of type void then the constructor behaves as |
| 2964 | // if it was passed NULL. |
| 2965 | explicit ReturnInst(LLVMContext &C, Value *retVal = nullptr, |
| 2966 | Instruction *InsertBefore = nullptr); |
| 2967 | ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd); |
| 2968 | explicit ReturnInst(LLVMContext &C, BasicBlock *InsertAtEnd); |
| 2969 | |
| 2970 | protected: |
| 2971 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 2972 | friend class Instruction; |
| 2973 | |
| 2974 | ReturnInst *cloneImpl() const; |
| 2975 | |
| 2976 | public: |
| 2977 | static ReturnInst* Create(LLVMContext &C, Value *retVal = nullptr, |
| 2978 | Instruction *InsertBefore = nullptr) { |
| 2979 | return new(!!retVal) ReturnInst(C, retVal, InsertBefore); |
| 2980 | } |
| 2981 | |
| 2982 | static ReturnInst* Create(LLVMContext &C, Value *retVal, |
| 2983 | BasicBlock *InsertAtEnd) { |
| 2984 | return new(!!retVal) ReturnInst(C, retVal, InsertAtEnd); |
| 2985 | } |
| 2986 | |
| 2987 | static ReturnInst* Create(LLVMContext &C, BasicBlock *InsertAtEnd) { |
| 2988 | return new(0) ReturnInst(C, InsertAtEnd); |
| 2989 | } |
| 2990 | |
| 2991 | /// Provide fast operand accessors |
| 2992 | DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void setOperand(unsigned, Value*); inline op_iterator op_begin(); inline const_op_iterator op_begin() const; inline op_iterator op_end(); inline const_op_iterator op_end() const; protected : template <int> inline Use &Op(); template <int > inline const Use &Op() const; public: inline unsigned getNumOperands() const; |
| 2993 | |
| 2994 | /// Convenience accessor. Returns null if there is no return value. |
| 2995 | Value *getReturnValue() const { |
| 2996 | return getNumOperands() != 0 ? getOperand(0) : nullptr; |
| 2997 | } |
| 2998 | |
| 2999 | unsigned getNumSuccessors() const { return 0; } |
| 3000 | |
| 3001 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 3002 | static bool classof(const Instruction *I) { |
| 3003 | return (I->getOpcode() == Instruction::Ret); |
| 3004 | } |
| 3005 | static bool classof(const Value *V) { |
| 3006 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 3007 | } |
| 3008 | |
| 3009 | private: |
| 3010 | BasicBlock *getSuccessor(unsigned idx) const { |
| 3011 | llvm_unreachable("ReturnInst has no successors!")__builtin_unreachable(); |
| 3012 | } |
| 3013 | |
| 3014 | void setSuccessor(unsigned idx, BasicBlock *B) { |
| 3015 | llvm_unreachable("ReturnInst has no successors!")__builtin_unreachable(); |
| 3016 | } |
| 3017 | }; |
| 3018 | |
| 3019 | template <> |
| 3020 | struct OperandTraits<ReturnInst> : public VariadicOperandTraits<ReturnInst> { |
| 3021 | }; |
| 3022 | |
| 3023 | DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)ReturnInst::op_iterator ReturnInst::op_begin() { return OperandTraits <ReturnInst>::op_begin(this); } ReturnInst::const_op_iterator ReturnInst::op_begin() const { return OperandTraits<ReturnInst >::op_begin(const_cast<ReturnInst*>(this)); } ReturnInst ::op_iterator ReturnInst::op_end() { return OperandTraits< ReturnInst>::op_end(this); } ReturnInst::const_op_iterator ReturnInst::op_end() const { return OperandTraits<ReturnInst >::op_end(const_cast<ReturnInst*>(this)); } Value *ReturnInst ::getOperand(unsigned i_nocapture) const { ((void)0); return cast_or_null <Value>( OperandTraits<ReturnInst>::op_begin(const_cast <ReturnInst*>(this))[i_nocapture].get()); } void ReturnInst ::setOperand(unsigned i_nocapture, Value *Val_nocapture) { (( void)0); OperandTraits<ReturnInst>::op_begin(this)[i_nocapture ] = Val_nocapture; } unsigned ReturnInst::getNumOperands() const { return OperandTraits<ReturnInst>::operands(this); } template <int Idx_nocapture> Use &ReturnInst::Op() { return this->OpFrom<Idx_nocapture>(this); } template <int Idx_nocapture> const Use &ReturnInst::Op() const { return this->OpFrom<Idx_nocapture>(this); } |
| 3024 | |
| 3025 | //===----------------------------------------------------------------------===// |
| 3026 | // BranchInst Class |
| 3027 | //===----------------------------------------------------------------------===// |
| 3028 | |
| 3029 | //===--------------------------------------------------------------------------- |
| 3030 | /// Conditional or Unconditional Branch instruction. |
| 3031 | /// |
| 3032 | class BranchInst : public Instruction { |
| 3033 | /// Ops list - Branches are strange. The operands are ordered: |
| 3034 | /// [Cond, FalseDest,] TrueDest. This makes some accessors faster because |
| 3035 | /// they don't have to check for cond/uncond branchness. These are mostly |
| 3036 | /// accessed relative from op_end(). |
| 3037 | BranchInst(const BranchInst &BI); |
| 3038 | // BranchInst constructors (where {B, T, F} are blocks, and C is a condition): |
| 3039 | // BranchInst(BB *B) - 'br B' |
| 3040 | // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F' |
| 3041 | // BranchInst(BB* B, Inst *I) - 'br B' insert before I |
| 3042 | // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I |
| 3043 | // BranchInst(BB* B, BB *I) - 'br B' insert at end |
| 3044 | // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end |
| 3045 | explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = nullptr); |
| 3046 | BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond, |
| 3047 | Instruction *InsertBefore = nullptr); |
| 3048 | BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd); |
| 3049 | BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond, |
| 3050 | BasicBlock *InsertAtEnd); |
| 3051 | |
| 3052 | void AssertOK(); |
| 3053 | |
| 3054 | protected: |
| 3055 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 3056 | friend class Instruction; |
| 3057 | |
| 3058 | BranchInst *cloneImpl() const; |
| 3059 | |
| 3060 | public: |
| 3061 | /// Iterator type that casts an operand to a basic block. |
| 3062 | /// |
| 3063 | /// This only makes sense because the successors are stored as adjacent |
| 3064 | /// operands for branch instructions. |
| 3065 | struct succ_op_iterator |
| 3066 | : iterator_adaptor_base<succ_op_iterator, value_op_iterator, |
| 3067 | std::random_access_iterator_tag, BasicBlock *, |
| 3068 | ptrdiff_t, BasicBlock *, BasicBlock *> { |
| 3069 | explicit succ_op_iterator(value_op_iterator I) : iterator_adaptor_base(I) {} |
| 3070 | |
| 3071 | BasicBlock *operator*() const { return cast<BasicBlock>(*I); } |
| 3072 | BasicBlock *operator->() const { return operator*(); } |
| 3073 | }; |
| 3074 | |
| 3075 | /// The const version of `succ_op_iterator`. |
| 3076 | struct const_succ_op_iterator |
| 3077 | : iterator_adaptor_base<const_succ_op_iterator, const_value_op_iterator, |
| 3078 | std::random_access_iterator_tag, |
| 3079 | const BasicBlock *, ptrdiff_t, const BasicBlock *, |
| 3080 | const BasicBlock *> { |
| 3081 | explicit const_succ_op_iterator(const_value_op_iterator I) |
| 3082 | : iterator_adaptor_base(I) {} |
| 3083 | |
| 3084 | const BasicBlock *operator*() const { return cast<BasicBlock>(*I); } |
| 3085 | const BasicBlock *operator->() const { return operator*(); } |
| 3086 | }; |
| 3087 | |
| 3088 | static BranchInst *Create(BasicBlock *IfTrue, |
| 3089 | Instruction *InsertBefore = nullptr) { |
| 3090 | return new(1) BranchInst(IfTrue, InsertBefore); |
| 3091 | } |
| 3092 | |
| 3093 | static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse, |
| 3094 | Value *Cond, Instruction *InsertBefore = nullptr) { |
| 3095 | return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore); |
| 3096 | } |
| 3097 | |
| 3098 | static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) { |
| 3099 | return new(1) BranchInst(IfTrue, InsertAtEnd); |
| 3100 | } |
| 3101 | |
| 3102 | static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse, |
| 3103 | Value *Cond, BasicBlock *InsertAtEnd) { |
| 3104 | return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd); |
| 3105 | } |
| 3106 | |
| 3107 | /// Transparently provide more efficient getOperand methods. |
| 3108 | DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void setOperand(unsigned, Value*); inline op_iterator op_begin(); inline const_op_iterator op_begin() const; inline op_iterator op_end(); inline const_op_iterator op_end() const; protected : template <int> inline Use &Op(); template <int > inline const Use &Op() const; public: inline unsigned getNumOperands() const; |
| 3109 | |
| 3110 | bool isUnconditional() const { return getNumOperands() == 1; } |
| 3111 | bool isConditional() const { return getNumOperands() == 3; } |
| 3112 | |
| 3113 | Value *getCondition() const { |
| 3114 | assert(isConditional() && "Cannot get condition of an uncond branch!")((void)0); |
| 3115 | return Op<-3>(); |
| 3116 | } |
| 3117 | |
| 3118 | void setCondition(Value *V) { |
| 3119 | assert(isConditional() && "Cannot set condition of unconditional branch!")((void)0); |
| 3120 | Op<-3>() = V; |
| 3121 | } |
| 3122 | |
| 3123 | unsigned getNumSuccessors() const { return 1+isConditional(); } |
| 3124 | |
| 3125 | BasicBlock *getSuccessor(unsigned i) const { |
| 3126 | assert(i < getNumSuccessors() && "Successor # out of range for Branch!")((void)0); |
| 3127 | return cast_or_null<BasicBlock>((&Op<-1>() - i)->get()); |
| 3128 | } |
| 3129 | |
| 3130 | void setSuccessor(unsigned idx, BasicBlock *NewSucc) { |
| 3131 | assert(idx < getNumSuccessors() && "Successor # out of range for Branch!")((void)0); |
| 3132 | *(&Op<-1>() - idx) = NewSucc; |
| 3133 | } |
| 3134 | |
| 3135 | /// Swap the successors of this branch instruction. |
| 3136 | /// |
| 3137 | /// Swaps the successors of the branch instruction. This also swaps any |
| 3138 | /// branch weight metadata associated with the instruction so that it |
| 3139 | /// continues to map correctly to each operand. |
| 3140 | void swapSuccessors(); |
| 3141 | |
| 3142 | iterator_range<succ_op_iterator> successors() { |
| 3143 | return make_range( |
| 3144 | succ_op_iterator(std::next(value_op_begin(), isConditional() ? 1 : 0)), |
| 3145 | succ_op_iterator(value_op_end())); |
| 3146 | } |
| 3147 | |
| 3148 | iterator_range<const_succ_op_iterator> successors() const { |
| 3149 | return make_range(const_succ_op_iterator( |
| 3150 | std::next(value_op_begin(), isConditional() ? 1 : 0)), |
| 3151 | const_succ_op_iterator(value_op_end())); |
| 3152 | } |
| 3153 | |
| 3154 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 3155 | static bool classof(const Instruction *I) { |
| 3156 | return (I->getOpcode() == Instruction::Br); |
| 3157 | } |
| 3158 | static bool classof(const Value *V) { |
| 3159 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 3160 | } |
| 3161 | }; |
| 3162 | |
| 3163 | template <> |
| 3164 | struct OperandTraits<BranchInst> : public VariadicOperandTraits<BranchInst, 1> { |
| 3165 | }; |
| 3166 | |
| 3167 | DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)BranchInst::op_iterator BranchInst::op_begin() { return OperandTraits <BranchInst>::op_begin(this); } BranchInst::const_op_iterator BranchInst::op_begin() const { return OperandTraits<BranchInst >::op_begin(const_cast<BranchInst*>(this)); } BranchInst ::op_iterator BranchInst::op_end() { return OperandTraits< BranchInst>::op_end(this); } BranchInst::const_op_iterator BranchInst::op_end() const { return OperandTraits<BranchInst >::op_end(const_cast<BranchInst*>(this)); } Value *BranchInst ::getOperand(unsigned i_nocapture) const { ((void)0); return cast_or_null <Value>( OperandTraits<BranchInst>::op_begin(const_cast <BranchInst*>(this))[i_nocapture].get()); } void BranchInst ::setOperand(unsigned i_nocapture, Value *Val_nocapture) { (( void)0); OperandTraits<BranchInst>::op_begin(this)[i_nocapture ] = Val_nocapture; } unsigned BranchInst::getNumOperands() const { return OperandTraits<BranchInst>::operands(this); } template <int Idx_nocapture> Use &BranchInst::Op() { return this->OpFrom<Idx_nocapture>(this); } template <int Idx_nocapture> const Use &BranchInst::Op() const { return this->OpFrom<Idx_nocapture>(this); } |
| 3168 | |
| 3169 | //===----------------------------------------------------------------------===// |
| 3170 | // SwitchInst Class |
| 3171 | //===----------------------------------------------------------------------===// |
| 3172 | |
| 3173 | //===--------------------------------------------------------------------------- |
| 3174 | /// Multiway switch |
| 3175 | /// |
| 3176 | class SwitchInst : public Instruction { |
| 3177 | unsigned ReservedSpace; |
| 3178 | |
| 3179 | // Operand[0] = Value to switch on |
| 3180 | // Operand[1] = Default basic block destination |
| 3181 | // Operand[2n ] = Value to match |
| 3182 | // Operand[2n+1] = BasicBlock to go to on match |
| 3183 | SwitchInst(const SwitchInst &SI); |
| 3184 | |
| 3185 | /// Create a new switch instruction, specifying a value to switch on and a |
| 3186 | /// default destination. The number of additional cases can be specified here |
| 3187 | /// to make memory allocation more efficient. This constructor can also |
| 3188 | /// auto-insert before another instruction. |
| 3189 | SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases, |
| 3190 | Instruction *InsertBefore); |
| 3191 | |
| 3192 | /// Create a new switch instruction, specifying a value to switch on and a |
| 3193 | /// default destination. The number of additional cases can be specified here |
| 3194 | /// to make memory allocation more efficient. This constructor also |
| 3195 | /// auto-inserts at the end of the specified BasicBlock. |
| 3196 | SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases, |
| 3197 | BasicBlock *InsertAtEnd); |
| 3198 | |
| 3199 | // allocate space for exactly zero operands |
| 3200 | void *operator new(size_t S) { return User::operator new(S); } |
| 3201 | |
| 3202 | void init(Value *Value, BasicBlock *Default, unsigned NumReserved); |
| 3203 | void growOperands(); |
| 3204 | |
| 3205 | protected: |
| 3206 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 3207 | friend class Instruction; |
| 3208 | |
| 3209 | SwitchInst *cloneImpl() const; |
| 3210 | |
| 3211 | public: |
| 3212 | void operator delete(void *Ptr) { User::operator delete(Ptr); } |
| 3213 | |
| 3214 | // -2 |
| 3215 | static const unsigned DefaultPseudoIndex = static_cast<unsigned>(~0L-1); |
| 3216 | |
| 3217 | template <typename CaseHandleT> class CaseIteratorImpl; |
| 3218 | |
| 3219 | /// A handle to a particular switch case. It exposes a convenient interface |
| 3220 | /// to both the case value and the successor block. |
| 3221 | /// |
| 3222 | /// We define this as a template and instantiate it to form both a const and |
| 3223 | /// non-const handle. |
| 3224 | template <typename SwitchInstT, typename ConstantIntT, typename BasicBlockT> |
| 3225 | class CaseHandleImpl { |
| 3226 | // Directly befriend both const and non-const iterators. |
| 3227 | friend class SwitchInst::CaseIteratorImpl< |
| 3228 | CaseHandleImpl<SwitchInstT, ConstantIntT, BasicBlockT>>; |
| 3229 | |
| 3230 | protected: |
| 3231 | // Expose the switch type we're parameterized with to the iterator. |
| 3232 | using SwitchInstType = SwitchInstT; |
| 3233 | |
| 3234 | SwitchInstT *SI; |
| 3235 | ptrdiff_t Index; |
| 3236 | |
| 3237 | CaseHandleImpl() = default; |
| 3238 | CaseHandleImpl(SwitchInstT *SI, ptrdiff_t Index) : SI(SI), Index(Index) {} |
| 3239 | |
| 3240 | public: |
| 3241 | /// Resolves case value for current case. |
| 3242 | ConstantIntT *getCaseValue() const { |
| 3243 | assert((unsigned)Index < SI->getNumCases() &&((void)0) |
| 3244 | "Index out the number of cases.")((void)0); |
| 3245 | return reinterpret_cast<ConstantIntT *>(SI->getOperand(2 + Index * 2)); |
| 3246 | } |
| 3247 | |
| 3248 | /// Resolves successor for current case. |
| 3249 | BasicBlockT *getCaseSuccessor() const { |
| 3250 | assert(((unsigned)Index < SI->getNumCases() ||((void)0) |
| 3251 | (unsigned)Index == DefaultPseudoIndex) &&((void)0) |
| 3252 | "Index out the number of cases.")((void)0); |
| 3253 | return SI->getSuccessor(getSuccessorIndex()); |
| 3254 | } |
| 3255 | |
| 3256 | /// Returns number of current case. |
| 3257 | unsigned getCaseIndex() const { return Index; } |
| 3258 | |
| 3259 | /// Returns successor index for current case successor. |
| 3260 | unsigned getSuccessorIndex() const { |
| 3261 | assert(((unsigned)Index == DefaultPseudoIndex ||((void)0) |
| 3262 | (unsigned)Index < SI->getNumCases()) &&((void)0) |
| 3263 | "Index out the number of cases.")((void)0); |
| 3264 | return (unsigned)Index != DefaultPseudoIndex ? Index + 1 : 0; |
| 3265 | } |
| 3266 | |
| 3267 | bool operator==(const CaseHandleImpl &RHS) const { |
| 3268 | assert(SI == RHS.SI && "Incompatible operators.")((void)0); |
| 3269 | return Index == RHS.Index; |
| 3270 | } |
| 3271 | }; |
| 3272 | |
| 3273 | using ConstCaseHandle = |
| 3274 | CaseHandleImpl<const SwitchInst, const ConstantInt, const BasicBlock>; |
| 3275 | |
| 3276 | class CaseHandle |
| 3277 | : public CaseHandleImpl<SwitchInst, ConstantInt, BasicBlock> { |
| 3278 | friend class SwitchInst::CaseIteratorImpl<CaseHandle>; |
| 3279 | |
| 3280 | public: |
| 3281 | CaseHandle(SwitchInst *SI, ptrdiff_t Index) : CaseHandleImpl(SI, Index) {} |
| 3282 | |
| 3283 | /// Sets the new value for current case. |
| 3284 | void setValue(ConstantInt *V) { |
| 3285 | assert((unsigned)Index < SI->getNumCases() &&((void)0) |
| 3286 | "Index out the number of cases.")((void)0); |
| 3287 | SI->setOperand(2 + Index*2, reinterpret_cast<Value*>(V)); |
| 3288 | } |
| 3289 | |
| 3290 | /// Sets the new successor for current case. |
| 3291 | void setSuccessor(BasicBlock *S) { |
| 3292 | SI->setSuccessor(getSuccessorIndex(), S); |
| 3293 | } |
| 3294 | }; |
| 3295 | |
| 3296 | template <typename CaseHandleT> |
| 3297 | class CaseIteratorImpl |
| 3298 | : public iterator_facade_base<CaseIteratorImpl<CaseHandleT>, |
| 3299 | std::random_access_iterator_tag, |
| 3300 | CaseHandleT> { |
| 3301 | using SwitchInstT = typename CaseHandleT::SwitchInstType; |
| 3302 | |
| 3303 | CaseHandleT Case; |
| 3304 | |
| 3305 | public: |
| 3306 | /// Default constructed iterator is in an invalid state until assigned to |
| 3307 | /// a case for a particular switch. |
| 3308 | CaseIteratorImpl() = default; |
| 3309 | |
| 3310 | /// Initializes case iterator for given SwitchInst and for given |
| 3311 | /// case number. |
| 3312 | CaseIteratorImpl(SwitchInstT *SI, unsigned CaseNum) : Case(SI, CaseNum) {} |
| 3313 | |
| 3314 | /// Initializes case iterator for given SwitchInst and for given |
| 3315 | /// successor index. |
| 3316 | static CaseIteratorImpl fromSuccessorIndex(SwitchInstT *SI, |
| 3317 | unsigned SuccessorIndex) { |
| 3318 | assert(SuccessorIndex < SI->getNumSuccessors() &&((void)0) |
| 3319 | "Successor index # out of range!")((void)0); |
| 3320 | return SuccessorIndex != 0 ? CaseIteratorImpl(SI, SuccessorIndex - 1) |
| 3321 | : CaseIteratorImpl(SI, DefaultPseudoIndex); |
| 3322 | } |
| 3323 | |
| 3324 | /// Support converting to the const variant. This will be a no-op for const |
| 3325 | /// variant. |
| 3326 | operator CaseIteratorImpl<ConstCaseHandle>() const { |
| 3327 | return CaseIteratorImpl<ConstCaseHandle>(Case.SI, Case.Index); |
| 3328 | } |
| 3329 | |
| 3330 | CaseIteratorImpl &operator+=(ptrdiff_t N) { |
| 3331 | // Check index correctness after addition. |
| 3332 | // Note: Index == getNumCases() means end(). |
| 3333 | assert(Case.Index + N >= 0 &&((void)0) |
| 3334 | (unsigned)(Case.Index + N) <= Case.SI->getNumCases() &&((void)0) |
| 3335 | "Case.Index out the number of cases.")((void)0); |
| 3336 | Case.Index += N; |
| 3337 | return *this; |
| 3338 | } |
| 3339 | CaseIteratorImpl &operator-=(ptrdiff_t N) { |
| 3340 | // Check index correctness after subtraction. |
| 3341 | // Note: Case.Index == getNumCases() means end(). |
| 3342 | assert(Case.Index - N >= 0 &&((void)0) |
| 3343 | (unsigned)(Case.Index - N) <= Case.SI->getNumCases() &&((void)0) |
| 3344 | "Case.Index out the number of cases.")((void)0); |
| 3345 | Case.Index -= N; |
| 3346 | return *this; |
| 3347 | } |
| 3348 | ptrdiff_t operator-(const CaseIteratorImpl &RHS) const { |
| 3349 | assert(Case.SI == RHS.Case.SI && "Incompatible operators.")((void)0); |
| 3350 | return Case.Index - RHS.Case.Index; |
| 3351 | } |
| 3352 | bool operator==(const CaseIteratorImpl &RHS) const { |
| 3353 | return Case == RHS.Case; |
| 3354 | } |
| 3355 | bool operator<(const CaseIteratorImpl &RHS) const { |
| 3356 | assert(Case.SI == RHS.Case.SI && "Incompatible operators.")((void)0); |
| 3357 | return Case.Index < RHS.Case.Index; |
| 3358 | } |
| 3359 | CaseHandleT &operator*() { return Case; } |
| 3360 | const CaseHandleT &operator*() const { return Case; } |
| 3361 | }; |
| 3362 | |
| 3363 | using CaseIt = CaseIteratorImpl<CaseHandle>; |
| 3364 | using ConstCaseIt = CaseIteratorImpl<ConstCaseHandle>; |
| 3365 | |
| 3366 | static SwitchInst *Create(Value *Value, BasicBlock *Default, |
| 3367 | unsigned NumCases, |
| 3368 | Instruction *InsertBefore = nullptr) { |
| 3369 | return new SwitchInst(Value, Default, NumCases, InsertBefore); |
| 3370 | } |
| 3371 | |
| 3372 | static SwitchInst *Create(Value *Value, BasicBlock *Default, |
| 3373 | unsigned NumCases, BasicBlock *InsertAtEnd) { |
| 3374 | return new SwitchInst(Value, Default, NumCases, InsertAtEnd); |
| 3375 | } |
| 3376 | |
| 3377 | /// Provide fast operand accessors |
| 3378 | DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void setOperand(unsigned, Value*); inline op_iterator op_begin(); inline const_op_iterator op_begin() const; inline op_iterator op_end(); inline const_op_iterator op_end() const; protected : template <int> inline Use &Op(); template <int > inline const Use &Op() const; public: inline unsigned getNumOperands() const; |
| 3379 | |
| 3380 | // Accessor Methods for Switch stmt |
| 3381 | Value *getCondition() const { return getOperand(0); } |
| 3382 | void setCondition(Value *V) { setOperand(0, V); } |
| 3383 | |
| 3384 | BasicBlock *getDefaultDest() const { |
| 3385 | return cast<BasicBlock>(getOperand(1)); |
| 3386 | } |
| 3387 | |
| 3388 | void setDefaultDest(BasicBlock *DefaultCase) { |
| 3389 | setOperand(1, reinterpret_cast<Value*>(DefaultCase)); |
| 3390 | } |
| 3391 | |
| 3392 | /// Return the number of 'cases' in this switch instruction, excluding the |
| 3393 | /// default case. |
| 3394 | unsigned getNumCases() const { |
| 3395 | return getNumOperands()/2 - 1; |
| 3396 | } |
| 3397 | |
| 3398 | /// Returns a read/write iterator that points to the first case in the |
| 3399 | /// SwitchInst. |
| 3400 | CaseIt case_begin() { |
| 3401 | return CaseIt(this, 0); |
| 3402 | } |
| 3403 | |
| 3404 | /// Returns a read-only iterator that points to the first case in the |
| 3405 | /// SwitchInst. |
| 3406 | ConstCaseIt case_begin() const { |
| 3407 | return ConstCaseIt(this, 0); |
| 3408 | } |
| 3409 | |
| 3410 | /// Returns a read/write iterator that points one past the last in the |
| 3411 | /// SwitchInst. |
| 3412 | CaseIt case_end() { |
| 3413 | return CaseIt(this, getNumCases()); |
| 3414 | } |
| 3415 | |
| 3416 | /// Returns a read-only iterator that points one past the last in the |
| 3417 | /// SwitchInst. |
| 3418 | ConstCaseIt case_end() const { |
| 3419 | return ConstCaseIt(this, getNumCases()); |
| 3420 | } |
| 3421 | |
| 3422 | /// Iteration adapter for range-for loops. |
| 3423 | iterator_range<CaseIt> cases() { |
| 3424 | return make_range(case_begin(), case_end()); |
| 3425 | } |
| 3426 | |
| 3427 | /// Constant iteration adapter for range-for loops. |
| 3428 | iterator_range<ConstCaseIt> cases() const { |
| 3429 | return make_range(case_begin(), case_end()); |
| 3430 | } |
| 3431 | |
| 3432 | /// Returns an iterator that points to the default case. |
| 3433 | /// Note: this iterator allows to resolve successor only. Attempt |
| 3434 | /// to resolve case value causes an assertion. |
| 3435 | /// Also note, that increment and decrement also causes an assertion and |
| 3436 | /// makes iterator invalid. |
| 3437 | CaseIt case_default() { |
| 3438 | return CaseIt(this, DefaultPseudoIndex); |
| 3439 | } |
| 3440 | ConstCaseIt case_default() const { |
| 3441 | return ConstCaseIt(this, DefaultPseudoIndex); |
| 3442 | } |
| 3443 | |
| 3444 | /// Search all of the case values for the specified constant. If it is |
| 3445 | /// explicitly handled, return the case iterator of it, otherwise return |
| 3446 | /// default case iterator to indicate that it is handled by the default |
| 3447 | /// handler. |
| 3448 | CaseIt findCaseValue(const ConstantInt *C) { |
| 3449 | CaseIt I = llvm::find_if( |
| 3450 | cases(), [C](CaseHandle &Case) { return Case.getCaseValue() == C; }); |
| 3451 | if (I != case_end()) |
| 3452 | return I; |
| 3453 | |
| 3454 | return case_default(); |
| 3455 | } |
| 3456 | ConstCaseIt findCaseValue(const ConstantInt *C) const { |
| 3457 | ConstCaseIt I = llvm::find_if(cases(), [C](ConstCaseHandle &Case) { |
| 3458 | return Case.getCaseValue() == C; |
| 3459 | }); |
| 3460 | if (I != case_end()) |
| 3461 | return I; |
| 3462 | |
| 3463 | return case_default(); |
| 3464 | } |
| 3465 | |
| 3466 | /// Finds the unique case value for a given successor. Returns null if the |
| 3467 | /// successor is not found, not unique, or is the default case. |
| 3468 | ConstantInt *findCaseDest(BasicBlock *BB) { |
| 3469 | if (BB == getDefaultDest()) |
| 3470 | return nullptr; |
| 3471 | |
| 3472 | ConstantInt *CI = nullptr; |
| 3473 | for (auto Case : cases()) { |
| 3474 | if (Case.getCaseSuccessor() != BB) |
| 3475 | continue; |
| 3476 | |
| 3477 | if (CI) |
| 3478 | return nullptr; // Multiple cases lead to BB. |
| 3479 | |
| 3480 | CI = Case.getCaseValue(); |
| 3481 | } |
| 3482 | |
| 3483 | return CI; |
| 3484 | } |
| 3485 | |
| 3486 | /// Add an entry to the switch instruction. |
| 3487 | /// Note: |
| 3488 | /// This action invalidates case_end(). Old case_end() iterator will |
| 3489 | /// point to the added case. |
| 3490 | void addCase(ConstantInt *OnVal, BasicBlock *Dest); |
| 3491 | |
| 3492 | /// This method removes the specified case and its successor from the switch |
| 3493 | /// instruction. Note that this operation may reorder the remaining cases at |
| 3494 | /// index idx and above. |
| 3495 | /// Note: |
| 3496 | /// This action invalidates iterators for all cases following the one removed, |
| 3497 | /// including the case_end() iterator. It returns an iterator for the next |
| 3498 | /// case. |
| 3499 | CaseIt removeCase(CaseIt I); |
| 3500 | |
| 3501 | unsigned getNumSuccessors() const { return getNumOperands()/2; } |
| 3502 | BasicBlock *getSuccessor(unsigned idx) const { |
| 3503 | assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!")((void)0); |
| 3504 | return cast<BasicBlock>(getOperand(idx*2+1)); |
| 3505 | } |
| 3506 | void setSuccessor(unsigned idx, BasicBlock *NewSucc) { |
| 3507 | assert(idx < getNumSuccessors() && "Successor # out of range for switch!")((void)0); |
| 3508 | setOperand(idx * 2 + 1, NewSucc); |
| 3509 | } |
| 3510 | |
| 3511 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 3512 | static bool classof(const Instruction *I) { |
| 3513 | return I->getOpcode() == Instruction::Switch; |
| 3514 | } |
| 3515 | static bool classof(const Value *V) { |
| 3516 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 3517 | } |
| 3518 | }; |
| 3519 | |
| 3520 | /// A wrapper class to simplify modification of SwitchInst cases along with |
| 3521 | /// their prof branch_weights metadata. |
| 3522 | class SwitchInstProfUpdateWrapper { |
| 3523 | SwitchInst &SI; |
| 3524 | Optional<SmallVector<uint32_t, 8> > Weights = None; |
| 3525 | bool Changed = false; |
| 3526 | |
| 3527 | protected: |
| 3528 | static MDNode *getProfBranchWeightsMD(const SwitchInst &SI); |
| 3529 | |
| 3530 | MDNode *buildProfBranchWeightsMD(); |
| 3531 | |
| 3532 | void init(); |
| 3533 | |
| 3534 | public: |
| 3535 | using CaseWeightOpt = Optional<uint32_t>; |
| 3536 | SwitchInst *operator->() { return &SI; } |
| 3537 | SwitchInst &operator*() { return SI; } |
| 3538 | operator SwitchInst *() { return &SI; } |
| 3539 | |
| 3540 | SwitchInstProfUpdateWrapper(SwitchInst &SI) : SI(SI) { init(); } |
| 3541 | |
| 3542 | ~SwitchInstProfUpdateWrapper() { |
| 3543 | if (Changed) |
| 3544 | SI.setMetadata(LLVMContext::MD_prof, buildProfBranchWeightsMD()); |
| 3545 | } |
| 3546 | |
| 3547 | /// Delegate the call to the underlying SwitchInst::removeCase() and remove |
| 3548 | /// correspondent branch weight. |
| 3549 | SwitchInst::CaseIt removeCase(SwitchInst::CaseIt I); |
| 3550 | |
| 3551 | /// Delegate the call to the underlying SwitchInst::addCase() and set the |
| 3552 | /// specified branch weight for the added case. |
| 3553 | void addCase(ConstantInt *OnVal, BasicBlock *Dest, CaseWeightOpt W); |
| 3554 | |
| 3555 | /// Delegate the call to the underlying SwitchInst::eraseFromParent() and mark |
| 3556 | /// this object to not touch the underlying SwitchInst in destructor. |
| 3557 | SymbolTableList<Instruction>::iterator eraseFromParent(); |
| 3558 | |
| 3559 | void setSuccessorWeight(unsigned idx, CaseWeightOpt W); |
| 3560 | CaseWeightOpt getSuccessorWeight(unsigned idx); |
| 3561 | |
| 3562 | static CaseWeightOpt getSuccessorWeight(const SwitchInst &SI, unsigned idx); |
| 3563 | }; |
| 3564 | |
| 3565 | template <> |
| 3566 | struct OperandTraits<SwitchInst> : public HungoffOperandTraits<2> { |
| 3567 | }; |
| 3568 | |
| 3569 | DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)SwitchInst::op_iterator SwitchInst::op_begin() { return OperandTraits <SwitchInst>::op_begin(this); } SwitchInst::const_op_iterator SwitchInst::op_begin() const { return OperandTraits<SwitchInst >::op_begin(const_cast<SwitchInst*>(this)); } SwitchInst ::op_iterator SwitchInst::op_end() { return OperandTraits< SwitchInst>::op_end(this); } SwitchInst::const_op_iterator SwitchInst::op_end() const { return OperandTraits<SwitchInst >::op_end(const_cast<SwitchInst*>(this)); } Value *SwitchInst ::getOperand(unsigned i_nocapture) const { ((void)0); return cast_or_null <Value>( OperandTraits<SwitchInst>::op_begin(const_cast <SwitchInst*>(this))[i_nocapture].get()); } void SwitchInst ::setOperand(unsigned i_nocapture, Value *Val_nocapture) { (( void)0); OperandTraits<SwitchInst>::op_begin(this)[i_nocapture ] = Val_nocapture; } unsigned SwitchInst::getNumOperands() const { return OperandTraits<SwitchInst>::operands(this); } template <int Idx_nocapture> Use &SwitchInst::Op() { return this->OpFrom<Idx_nocapture>(this); } template <int Idx_nocapture> const Use &SwitchInst::Op() const { return this->OpFrom<Idx_nocapture>(this); } |
| 3570 | |
| 3571 | //===----------------------------------------------------------------------===// |
| 3572 | // IndirectBrInst Class |
| 3573 | //===----------------------------------------------------------------------===// |
| 3574 | |
| 3575 | //===--------------------------------------------------------------------------- |
| 3576 | /// Indirect Branch Instruction. |
| 3577 | /// |
| 3578 | class IndirectBrInst : public Instruction { |
| 3579 | unsigned ReservedSpace; |
| 3580 | |
| 3581 | // Operand[0] = Address to jump to |
| 3582 | // Operand[n+1] = n-th destination |
| 3583 | IndirectBrInst(const IndirectBrInst &IBI); |
| 3584 | |
| 3585 | /// Create a new indirectbr instruction, specifying an |
| 3586 | /// Address to jump to. The number of expected destinations can be specified |
| 3587 | /// here to make memory allocation more efficient. This constructor can also |
| 3588 | /// autoinsert before another instruction. |
| 3589 | IndirectBrInst(Value *Address, unsigned NumDests, Instruction *InsertBefore); |
| 3590 | |
| 3591 | /// Create a new indirectbr instruction, specifying an |
| 3592 | /// Address to jump to. The number of expected destinations can be specified |
| 3593 | /// here to make memory allocation more efficient. This constructor also |
| 3594 | /// autoinserts at the end of the specified BasicBlock. |
| 3595 | IndirectBrInst(Value *Address, unsigned NumDests, BasicBlock *InsertAtEnd); |
| 3596 | |
| 3597 | // allocate space for exactly zero operands |
| 3598 | void *operator new(size_t S) { return User::operator new(S); } |
| 3599 | |
| 3600 | void init(Value *Address, unsigned NumDests); |
| 3601 | void growOperands(); |
| 3602 | |
| 3603 | protected: |
| 3604 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 3605 | friend class Instruction; |
| 3606 | |
| 3607 | IndirectBrInst *cloneImpl() const; |
| 3608 | |
| 3609 | public: |
| 3610 | void operator delete(void *Ptr) { User::operator delete(Ptr); } |
| 3611 | |
| 3612 | /// Iterator type that casts an operand to a basic block. |
| 3613 | /// |
| 3614 | /// This only makes sense because the successors are stored as adjacent |
| 3615 | /// operands for indirectbr instructions. |
| 3616 | struct succ_op_iterator |
| 3617 | : iterator_adaptor_base<succ_op_iterator, value_op_iterator, |
| 3618 | std::random_access_iterator_tag, BasicBlock *, |
| 3619 | ptrdiff_t, BasicBlock *, BasicBlock *> { |
| 3620 | explicit succ_op_iterator(value_op_iterator I) : iterator_adaptor_base(I) {} |
| 3621 | |
| 3622 | BasicBlock *operator*() const { return cast<BasicBlock>(*I); } |
| 3623 | BasicBlock *operator->() const { return operator*(); } |
| 3624 | }; |
| 3625 | |
| 3626 | /// The const version of `succ_op_iterator`. |
| 3627 | struct const_succ_op_iterator |
| 3628 | : iterator_adaptor_base<const_succ_op_iterator, const_value_op_iterator, |
| 3629 | std::random_access_iterator_tag, |
| 3630 | const BasicBlock *, ptrdiff_t, const BasicBlock *, |
| 3631 | const BasicBlock *> { |
| 3632 | explicit const_succ_op_iterator(const_value_op_iterator I) |
| 3633 | : iterator_adaptor_base(I) {} |
| 3634 | |
| 3635 | const BasicBlock *operator*() const { return cast<BasicBlock>(*I); } |
| 3636 | const BasicBlock *operator->() const { return operator*(); } |
| 3637 | }; |
| 3638 | |
| 3639 | static IndirectBrInst *Create(Value *Address, unsigned NumDests, |
| 3640 | Instruction *InsertBefore = nullptr) { |
| 3641 | return new IndirectBrInst(Address, NumDests, InsertBefore); |
| 3642 | } |
| 3643 | |
| 3644 | static IndirectBrInst *Create(Value *Address, unsigned NumDests, |
| 3645 | BasicBlock *InsertAtEnd) { |
| 3646 | return new IndirectBrInst(Address, NumDests, InsertAtEnd); |
| 3647 | } |
| 3648 | |
| 3649 | /// Provide fast operand accessors. |
| 3650 | DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value)public: inline Value *getOperand(unsigned) const; inline void setOperand(unsigned, Value*); inline op_iterator op_begin(); inline const_op_iterator op_begin() const; inline op_iterator op_end(); inline const_op_iterator op_end() const; protected : template <int> inline Use &Op(); template <int > inline const Use &Op() const; public: inline unsigned getNumOperands() const; |
| 3651 | |
| 3652 | // Accessor Methods for IndirectBrInst instruction. |
| 3653 | Value *getAddress() { return getOperand(0); } |
| 3654 | const Value *getAddress() const { return getOperand(0); } |
| 3655 | void setAddress(Value *V) { setOperand(0, V); } |
| 3656 | |
| 3657 | /// return the number of possible destinations in this |
| 3658 | /// indirectbr instruction. |
| 3659 | unsigned getNumDestinations() const { return getNumOperands()-1; } |
| 3660 | |
| 3661 | /// Return the specified destination. |
| 3662 | BasicBlock *getDestination(unsigned i) { return getSuccessor(i); } |
| 3663 | const BasicBlock *getDestination(unsigned i) const { return getSuccessor(i); } |
| 3664 | |
| 3665 | /// Add a destination. |
| 3666 | /// |
| 3667 | void addDestination(BasicBlock *Dest); |
| 3668 | |
| 3669 | /// This method removes the specified successor from the |
| 3670 | /// indirectbr instruction. |
| 3671 | void removeDestination(unsigned i); |
| 3672 | |
| 3673 | unsigned getNumSuccessors() const { return getNumOperands()-1; } |
| 3674 | BasicBlock *getSuccessor(unsigned i) const { |
| 3675 | return cast<BasicBlock>(getOperand(i+1)); |
| 3676 | } |
| 3677 | void setSuccessor(unsigned i, BasicBlock *NewSucc) { |
| 3678 | setOperand(i + 1, NewSucc); |
| 3679 | } |
| 3680 | |
| 3681 | iterator_range<succ_op_iterator> successors() { |
| 3682 | return make_range(succ_op_iterator(std::next(value_op_begin())), |
| 3683 | succ_op_iterator(value_op_end())); |
| 3684 | } |
| 3685 | |
| 3686 | iterator_range<const_succ_op_iterator> successors() const { |
| 3687 | return make_range(const_succ_op_iterator(std::next(value_op_begin())), |
| 3688 | const_succ_op_iterator(value_op_end())); |
| 3689 | } |
| 3690 | |
| 3691 | // Methods for support type inquiry through isa, cast, and dyn_cast: |
| 3692 | static bool classof(const Instruction *I) { |
| 3693 | return I->getOpcode() == Instruction::IndirectBr; |
| 3694 | } |
| 3695 | static bool classof(const Value *V) { |
| 3696 | return isa<Instruction>(V) && classof(cast<Instruction>(V)); |
| 3697 | } |
| 3698 | }; |
| 3699 | |
| 3700 | template <> |
| 3701 | struct OperandTraits<IndirectBrInst> : public HungoffOperandTraits<1> { |
| 3702 | }; |
| 3703 | |
| 3704 | DEFINE_TRANSPARENT_OPERAND_ACCESSORS(IndirectBrInst, Value)IndirectBrInst::op_iterator IndirectBrInst::op_begin() { return OperandTraits<IndirectBrInst>::op_begin(this); } IndirectBrInst ::const_op_iterator IndirectBrInst::op_begin() const { return OperandTraits<IndirectBrInst>::op_begin(const_cast< IndirectBrInst*>(this)); } IndirectBrInst::op_iterator IndirectBrInst ::op_end() { return OperandTraits<IndirectBrInst>::op_end (this); } IndirectBrInst::const_op_iterator IndirectBrInst::op_end () const { return OperandTraits<IndirectBrInst>::op_end (const_cast<IndirectBrInst*>(this)); } Value *IndirectBrInst ::getOperand(unsigned i_nocapture) const { ((void)0); return cast_or_null <Value>( OperandTraits<IndirectBrInst>::op_begin( const_cast<IndirectBrInst*>(this))[i_nocapture].get()); } void IndirectBrInst::setOperand(unsigned i_nocapture, Value *Val_nocapture) { ((void)0); OperandTraits<IndirectBrInst >::op_begin(this)[i_nocapture] = Val_nocapture; } unsigned IndirectBrInst::getNumOperands() const { return OperandTraits <IndirectBrInst>::operands(this); } template <int Idx_nocapture > Use &IndirectBrInst::Op() { return this->OpFrom< Idx_nocapture>(this); } template <int Idx_nocapture> const Use &IndirectBrInst::Op() const { return this-> OpFrom<Idx_nocapture>(this); } |
| 3705 | |
| 3706 | //===----------------------------------------------------------------------===// |
| 3707 | // InvokeInst Class |
| 3708 | //===----------------------------------------------------------------------===// |
| 3709 | |
| 3710 | /// Invoke instruction. The SubclassData field is used to hold the |
| 3711 | /// calling convention of the call. |
| 3712 | /// |
| 3713 | class InvokeInst : public CallBase { |
| 3714 | /// The number of operands for this call beyond the called function, |
| 3715 | /// arguments, and operand bundles. |
| 3716 | static constexpr int NumExtraOperands = 2; |
| 3717 | |
| 3718 | /// The index from the end of the operand array to the normal destination. |
| 3719 | static constexpr int NormalDestOpEndIdx = -3; |
| 3720 | |
| 3721 | /// The index from the end of the operand array to the unwind destination. |
| 3722 | static constexpr int UnwindDestOpEndIdx = -2; |
| 3723 | |
| 3724 | InvokeInst(const InvokeInst &BI); |
| 3725 | |
| 3726 | /// Construct an InvokeInst given a range of arguments. |
| 3727 | /// |
| 3728 | /// Construct an InvokeInst from a range of arguments |
| 3729 | inline InvokeInst(FunctionType *Ty, Value *Func, BasicBlock *IfNormal, |
| 3730 | BasicBlock *IfException, ArrayRef<Value *> Args, |
| 3731 | ArrayRef<OperandBundleDef> Bundles, int NumOperands, |
| 3732 | const Twine &NameStr, Instruction *InsertBefore); |
| 3733 | |
| 3734 | inline InvokeInst(FunctionType *Ty, Value *Func, BasicBlock *IfNormal, |
| 3735 | BasicBlock *IfException, ArrayRef<Value *> Args, |
| 3736 | ArrayRef<OperandBundleDef> Bundles, int NumOperands, |
| 3737 | const Twine &NameStr, BasicBlock *InsertAtEnd); |
| 3738 | |
| 3739 | void init(FunctionType *Ty, Value *Func, BasicBlock *IfNormal, |
| 3740 | BasicBlock *IfException, ArrayRef<Value *> Args, |
| 3741 | ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr); |
| 3742 | |
| 3743 | /// Compute the number of operands to allocate. |
| 3744 | static int ComputeNumOperands(int NumArgs, int NumBundleInputs = 0) { |
| 3745 | // We need one operand for the called function, plus our extra operands and |
| 3746 | // the input operand counts provided. |
| 3747 | return 1 + NumExtraOperands + NumArgs + NumBundleInputs; |
| 3748 | } |
| 3749 | |
| 3750 | protected: |
| 3751 | // Note: Instruction needs to be a friend here to call cloneImpl. |
| 3752 | friend class Instruction; |
| 3753 | |
| 3754 | InvokeInst *cloneImpl() const; |
| 3755 | |
| 3756 | public: |
| 3757 | static InvokeInst *Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal, |
| 3758 | BasicBlock *IfException, ArrayRef<Value *> Args, |
| 3759 | const Twine &NameStr, |
| 3760 | Instruction *InsertBefore = nullptr) { |
| 3761 | int NumOperands = ComputeNumOperands(Args.size()); |
| 3762 | return new (NumOperands) |
| 3763 | InvokeInst(Ty, Func, IfNormal, IfException, Args, None, NumOperands, |
| 3764 | NameStr, InsertBefore); |
| 3765 | } |
| 3766 | |
| 3767 | static InvokeInst *Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal, |
| 3768 | BasicBlock *IfException, ArrayRef<Value *> Args, |
| 3769 | ArrayRef<OperandBundleDef> Bundles = None, |
| 3770 | const Twine &NameStr = "", |
| 3771 | Instruction *InsertBefore = nullptr) { |
| 3772 | int NumOperands = |
| 3773 | ComputeNumOperands(Args.size(), CountBundleInputs(Bundles)); |
| 3774 | unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo); |
| 3775 | |
| 3776 | return new (NumOperands, DescriptorBytes) |
| 3777 | InvokeInst(Ty, Func, IfNormal, IfException, Args, Bundles, NumOperands, |
| 3778 | NameStr, InsertBefore); |
| 3779 | } |
| 3780 | |
| 3781 | static InvokeInst *Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal, |
| 3782 | BasicBlock *IfException, ArrayRef<Value *> Args, |
| 3783 | const Twine &NameStr, BasicBlock *InsertAtEnd) { |
| 3784 | int NumOperands = ComputeNumOperands(Args.size()); |
| 3785 | return new (NumOperands) |
| 3786 | InvokeInst(Ty, Func, IfNormal, IfException, Args, None, NumOperands, |
| 3787 | NameStr, InsertAtEnd); |
| 3788 | } |
| 3789 | |
| 3790 | static InvokeInst *Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal, |
| 3791 | BasicBlock *IfException, ArrayRef<Value *> Args, |
| 3792 | ArrayRef<OperandBundleDef> Bundles, |
| 3793 | const Twine &NameStr, BasicBlock *InsertAtEnd) { |
| 3794 | int NumOperands = |
| 3795 | ComputeNumOperands(Args.size(), CountBundleInputs(Bundles)); |
| 3796 | unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo); |
| 3797 | |
| 3798 | return new (NumOperands, DescriptorBytes) |
| 3799 | InvokeInst(Ty, Func, IfNormal, IfException, Args, Bundles, NumOperands, |
| 3800 | NameStr, InsertAtEnd); |
| 3801 | } |
| 3802 | |
| 3803 | static InvokeInst *Create(FunctionCallee Func, BasicBlock *IfNormal, |
| 3804 | BasicBlock *IfException, ArrayRef<Value *> Args, |
| 3805 | const Twine &NameStr, |
| 3806 | Instruction *InsertBefore = nullptr) { |
| 3807 | return Create(Func.getFunctionType(), Func.getCallee(), IfNormal, |
| 3808 | IfException, Args, None, NameStr, InsertBefore); |
| 3809 | } |
| 3810 | |
| 3811 | static InvokeInst *Create(FunctionCallee Func, BasicBlock *IfNormal, |
| 3812 | BasicBlock *IfException, ArrayRef<Value *> Args, |
| 3813 | ArrayRef<OperandBundleDef> Bundles = None, |
| 3814 | const Twine &NameStr = "", |
| 3815 | Instruction *InsertBefore = nullptr) { |
| 3816 | return Create(Func.getFunctionType(), Func.getCallee(), IfNormal, |
| 3817 | IfException, Args, Bundles, NameStr, InsertBefore); |