1 //===- InstCombineCalls.cpp -----------------------------------------------===//
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 implements the visitCall, visitInvoke, and visitCallBr functions.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "InstCombineInternal.h"
14 #include "llvm/ADT/APFloat.h"
15 #include "llvm/ADT/APInt.h"
16 #include "llvm/ADT/APSInt.h"
17 #include "llvm/ADT/ArrayRef.h"
18 #include "llvm/ADT/FloatingPointMode.h"
19 #include "llvm/ADT/None.h"
20 #include "llvm/ADT/Optional.h"
21 #include "llvm/ADT/STLExtras.h"
22 #include "llvm/ADT/SmallVector.h"
23 #include "llvm/ADT/Statistic.h"
24 #include "llvm/ADT/Twine.h"
25 #include "llvm/Analysis/AliasAnalysis.h"
26 #include "llvm/Analysis/AssumeBundleQueries.h"
27 #include "llvm/Analysis/AssumptionCache.h"
28 #include "llvm/Analysis/InstructionSimplify.h"
29 #include "llvm/Analysis/Loads.h"
30 #include "llvm/Analysis/MemoryBuiltins.h"
31 #include "llvm/Analysis/TargetTransformInfo.h"
32 #include "llvm/Analysis/ValueTracking.h"
33 #include "llvm/Analysis/VectorUtils.h"
34 #include "llvm/IR/Attributes.h"
35 #include "llvm/IR/BasicBlock.h"
36 #include "llvm/IR/Constant.h"
37 #include "llvm/IR/Constants.h"
38 #include "llvm/IR/DataLayout.h"
39 #include "llvm/IR/DerivedTypes.h"
40 #include "llvm/IR/Function.h"
41 #include "llvm/IR/GlobalVariable.h"
42 #include "llvm/IR/InstrTypes.h"
43 #include "llvm/IR/Instruction.h"
44 #include "llvm/IR/Instructions.h"
45 #include "llvm/IR/IntrinsicInst.h"
46 #include "llvm/IR/Intrinsics.h"
47 #include "llvm/IR/IntrinsicsAArch64.h"
48 #include "llvm/IR/IntrinsicsAMDGPU.h"
49 #include "llvm/IR/IntrinsicsARM.h"
50 #include "llvm/IR/IntrinsicsHexagon.h"
51 #include "llvm/IR/LLVMContext.h"
52 #include "llvm/IR/Metadata.h"
53 #include "llvm/IR/PatternMatch.h"
54 #include "llvm/IR/Statepoint.h"
55 #include "llvm/IR/Type.h"
56 #include "llvm/IR/User.h"
57 #include "llvm/IR/Value.h"
58 #include "llvm/IR/ValueHandle.h"
59 #include "llvm/Support/AtomicOrdering.h"
60 #include "llvm/Support/Casting.h"
61 #include "llvm/Support/CommandLine.h"
62 #include "llvm/Support/Compiler.h"
63 #include "llvm/Support/Debug.h"
64 #include "llvm/Support/ErrorHandling.h"
65 #include "llvm/Support/KnownBits.h"
66 #include "llvm/Support/MathExtras.h"
67 #include "llvm/Support/raw_ostream.h"
68 #include "llvm/Transforms/InstCombine/InstCombineWorklist.h"
69 #include "llvm/Transforms/InstCombine/InstCombiner.h"
70 #include "llvm/Transforms/Utils/AssumeBundleBuilder.h"
71 #include "llvm/Transforms/Utils/Local.h"
72 #include "llvm/Transforms/Utils/SimplifyLibCalls.h"
73 #include <algorithm>
74 #include <cassert>
75 #include <cstdint>
76 #include <cstring>
77 #include <utility>
78 #include <vector>
79 
80 using namespace llvm;
81 using namespace PatternMatch;
82 
83 #define DEBUG_TYPE "instcombine"
84 
85 STATISTIC(NumSimplified, "Number of library calls simplified");
86 
87 static cl::opt<unsigned> GuardWideningWindow(
88     "instcombine-guard-widening-window",
89     cl::init(3),
90     cl::desc("How wide an instruction window to bypass looking for "
91              "another guard"));
92 
93 /// enable preservation of attributes in assume like:
94 /// call void @llvm.assume(i1 true) [ "nonnull"(i32* %PTR) ]
95 extern cl::opt<bool> EnableKnowledgeRetention;
96 
97 /// Return the specified type promoted as it would be to pass though a va_arg
98 /// area.
99 static Type *getPromotedType(Type *Ty) {
100   if (IntegerType* ITy = dyn_cast<IntegerType>(Ty)) {
101     if (ITy->getBitWidth() < 32)
102       return Type::getInt32Ty(Ty->getContext());
103   }
104   return Ty;
105 }
106 
107 Instruction *InstCombinerImpl::SimplifyAnyMemTransfer(AnyMemTransferInst *MI) {
108   Align DstAlign = getKnownAlignment(MI->getRawDest(), DL, MI, &AC, &DT);
109   MaybeAlign CopyDstAlign = MI->getDestAlign();
110   if (!CopyDstAlign || *CopyDstAlign < DstAlign) {
111     MI->setDestAlignment(DstAlign);
112     return MI;
113   }
114 
115   Align SrcAlign = getKnownAlignment(MI->getRawSource(), DL, MI, &AC, &DT);
116   MaybeAlign CopySrcAlign = MI->getSourceAlign();
117   if (!CopySrcAlign || *CopySrcAlign < SrcAlign) {
118     MI->setSourceAlignment(SrcAlign);
119     return MI;
120   }
121 
122   // If we have a store to a location which is known constant, we can conclude
123   // that the store must be storing the constant value (else the memory
124   // wouldn't be constant), and this must be a noop.
125   if (AA->pointsToConstantMemory(MI->getDest())) {
126     // Set the size of the copy to 0, it will be deleted on the next iteration.
127     MI->setLength(Constant::getNullValue(MI->getLength()->getType()));
128     return MI;
129   }
130 
131   // If MemCpyInst length is 1/2/4/8 bytes then replace memcpy with
132   // load/store.
133   ConstantInt *MemOpLength = dyn_cast<ConstantInt>(MI->getLength());
134   if (!MemOpLength) return nullptr;
135 
136   // Source and destination pointer types are always "i8*" for intrinsic.  See
137   // if the size is something we can handle with a single primitive load/store.
138   // A single load+store correctly handles overlapping memory in the memmove
139   // case.
140   uint64_t Size = MemOpLength->getLimitedValue();
141   assert(Size && "0-sized memory transferring should be removed already.");
142 
143   if (Size > 8 || (Size&(Size-1)))
144     return nullptr;  // If not 1/2/4/8 bytes, exit.
145 
146   // If it is an atomic and alignment is less than the size then we will
147   // introduce the unaligned memory access which will be later transformed
148   // into libcall in CodeGen. This is not evident performance gain so disable
149   // it now.
150   if (isa<AtomicMemTransferInst>(MI))
151     if (*CopyDstAlign < Size || *CopySrcAlign < Size)
152       return nullptr;
153 
154   // Use an integer load+store unless we can find something better.
155   unsigned SrcAddrSp =
156     cast<PointerType>(MI->getArgOperand(1)->getType())->getAddressSpace();
157   unsigned DstAddrSp =
158     cast<PointerType>(MI->getArgOperand(0)->getType())->getAddressSpace();
159 
160   IntegerType* IntType = IntegerType::get(MI->getContext(), Size<<3);
161   Type *NewSrcPtrTy = PointerType::get(IntType, SrcAddrSp);
162   Type *NewDstPtrTy = PointerType::get(IntType, DstAddrSp);
163 
164   // If the memcpy has metadata describing the members, see if we can get the
165   // TBAA tag describing our copy.
166   MDNode *CopyMD = nullptr;
167   if (MDNode *M = MI->getMetadata(LLVMContext::MD_tbaa)) {
168     CopyMD = M;
169   } else if (MDNode *M = MI->getMetadata(LLVMContext::MD_tbaa_struct)) {
170     if (M->getNumOperands() == 3 && M->getOperand(0) &&
171         mdconst::hasa<ConstantInt>(M->getOperand(0)) &&
172         mdconst::extract<ConstantInt>(M->getOperand(0))->isZero() &&
173         M->getOperand(1) &&
174         mdconst::hasa<ConstantInt>(M->getOperand(1)) &&
175         mdconst::extract<ConstantInt>(M->getOperand(1))->getValue() ==
176         Size &&
177         M->getOperand(2) && isa<MDNode>(M->getOperand(2)))
178       CopyMD = cast<MDNode>(M->getOperand(2));
179   }
180 
181   Value *Src = Builder.CreateBitCast(MI->getArgOperand(1), NewSrcPtrTy);
182   Value *Dest = Builder.CreateBitCast(MI->getArgOperand(0), NewDstPtrTy);
183   LoadInst *L = Builder.CreateLoad(IntType, Src);
184   // Alignment from the mem intrinsic will be better, so use it.
185   L->setAlignment(*CopySrcAlign);
186   if (CopyMD)
187     L->setMetadata(LLVMContext::MD_tbaa, CopyMD);
188   MDNode *LoopMemParallelMD =
189     MI->getMetadata(LLVMContext::MD_mem_parallel_loop_access);
190   if (LoopMemParallelMD)
191     L->setMetadata(LLVMContext::MD_mem_parallel_loop_access, LoopMemParallelMD);
192   MDNode *AccessGroupMD = MI->getMetadata(LLVMContext::MD_access_group);
193   if (AccessGroupMD)
194     L->setMetadata(LLVMContext::MD_access_group, AccessGroupMD);
195 
196   StoreInst *S = Builder.CreateStore(L, Dest);
197   // Alignment from the mem intrinsic will be better, so use it.
198   S->setAlignment(*CopyDstAlign);
199   if (CopyMD)
200     S->setMetadata(LLVMContext::MD_tbaa, CopyMD);
201   if (LoopMemParallelMD)
202     S->setMetadata(LLVMContext::MD_mem_parallel_loop_access, LoopMemParallelMD);
203   if (AccessGroupMD)
204     S->setMetadata(LLVMContext::MD_access_group, AccessGroupMD);
205 
206   if (auto *MT = dyn_cast<MemTransferInst>(MI)) {
207     // non-atomics can be volatile
208     L->setVolatile(MT->isVolatile());
209     S->setVolatile(MT->isVolatile());
210   }
211   if (isa<AtomicMemTransferInst>(MI)) {
212     // atomics have to be unordered
213     L->setOrdering(AtomicOrdering::Unordered);
214     S->setOrdering(AtomicOrdering::Unordered);
215   }
216 
217   // Set the size of the copy to 0, it will be deleted on the next iteration.
218   MI->setLength(Constant::getNullValue(MemOpLength->getType()));
219   return MI;
220 }
221 
222 Instruction *InstCombinerImpl::SimplifyAnyMemSet(AnyMemSetInst *MI) {
223   const Align KnownAlignment =
224       getKnownAlignment(MI->getDest(), DL, MI, &AC, &DT);
225   MaybeAlign MemSetAlign = MI->getDestAlign();
226   if (!MemSetAlign || *MemSetAlign < KnownAlignment) {
227     MI->setDestAlignment(KnownAlignment);
228     return MI;
229   }
230 
231   // If we have a store to a location which is known constant, we can conclude
232   // that the store must be storing the constant value (else the memory
233   // wouldn't be constant), and this must be a noop.
234   if (AA->pointsToConstantMemory(MI->getDest())) {
235     // Set the size of the copy to 0, it will be deleted on the next iteration.
236     MI->setLength(Constant::getNullValue(MI->getLength()->getType()));
237     return MI;
238   }
239 
240   // Extract the length and alignment and fill if they are constant.
241   ConstantInt *LenC = dyn_cast<ConstantInt>(MI->getLength());
242   ConstantInt *FillC = dyn_cast<ConstantInt>(MI->getValue());
243   if (!LenC || !FillC || !FillC->getType()->isIntegerTy(8))
244     return nullptr;
245   const uint64_t Len = LenC->getLimitedValue();
246   assert(Len && "0-sized memory setting should be removed already.");
247   const Align Alignment = assumeAligned(MI->getDestAlignment());
248 
249   // If it is an atomic and alignment is less than the size then we will
250   // introduce the unaligned memory access which will be later transformed
251   // into libcall in CodeGen. This is not evident performance gain so disable
252   // it now.
253   if (isa<AtomicMemSetInst>(MI))
254     if (Alignment < Len)
255       return nullptr;
256 
257   // memset(s,c,n) -> store s, c (for n=1,2,4,8)
258   if (Len <= 8 && isPowerOf2_32((uint32_t)Len)) {
259     Type *ITy = IntegerType::get(MI->getContext(), Len*8);  // n=1 -> i8.
260 
261     Value *Dest = MI->getDest();
262     unsigned DstAddrSp = cast<PointerType>(Dest->getType())->getAddressSpace();
263     Type *NewDstPtrTy = PointerType::get(ITy, DstAddrSp);
264     Dest = Builder.CreateBitCast(Dest, NewDstPtrTy);
265 
266     // Extract the fill value and store.
267     uint64_t Fill = FillC->getZExtValue()*0x0101010101010101ULL;
268     StoreInst *S = Builder.CreateStore(ConstantInt::get(ITy, Fill), Dest,
269                                        MI->isVolatile());
270     S->setAlignment(Alignment);
271     if (isa<AtomicMemSetInst>(MI))
272       S->setOrdering(AtomicOrdering::Unordered);
273 
274     // Set the size of the copy to 0, it will be deleted on the next iteration.
275     MI->setLength(Constant::getNullValue(LenC->getType()));
276     return MI;
277   }
278 
279   return nullptr;
280 }
281 
282 // TODO, Obvious Missing Transforms:
283 // * Narrow width by halfs excluding zero/undef lanes
284 Value *InstCombinerImpl::simplifyMaskedLoad(IntrinsicInst &II) {
285   Value *LoadPtr = II.getArgOperand(0);
286   const Align Alignment =
287       cast<ConstantInt>(II.getArgOperand(1))->getAlignValue();
288 
289   // If the mask is all ones or undefs, this is a plain vector load of the 1st
290   // argument.
291   if (maskIsAllOneOrUndef(II.getArgOperand(2)))
292     return Builder.CreateAlignedLoad(II.getType(), LoadPtr, Alignment,
293                                      "unmaskedload");
294 
295   // If we can unconditionally load from this address, replace with a
296   // load/select idiom. TODO: use DT for context sensitive query
297   if (isDereferenceablePointer(LoadPtr, II.getType(),
298                                II.getModule()->getDataLayout(), &II, nullptr)) {
299     Value *LI = Builder.CreateAlignedLoad(II.getType(), LoadPtr, Alignment,
300                                          "unmaskedload");
301     return Builder.CreateSelect(II.getArgOperand(2), LI, II.getArgOperand(3));
302   }
303 
304   return nullptr;
305 }
306 
307 // TODO, Obvious Missing Transforms:
308 // * Single constant active lane -> store
309 // * Narrow width by halfs excluding zero/undef lanes
310 Instruction *InstCombinerImpl::simplifyMaskedStore(IntrinsicInst &II) {
311   auto *ConstMask = dyn_cast<Constant>(II.getArgOperand(3));
312   if (!ConstMask)
313     return nullptr;
314 
315   // If the mask is all zeros, this instruction does nothing.
316   if (ConstMask->isNullValue())
317     return eraseInstFromFunction(II);
318 
319   // If the mask is all ones, this is a plain vector store of the 1st argument.
320   if (ConstMask->isAllOnesValue()) {
321     Value *StorePtr = II.getArgOperand(1);
322     Align Alignment = cast<ConstantInt>(II.getArgOperand(2))->getAlignValue();
323     return new StoreInst(II.getArgOperand(0), StorePtr, false, Alignment);
324   }
325 
326   if (isa<ScalableVectorType>(ConstMask->getType()))
327     return nullptr;
328 
329   // Use masked off lanes to simplify operands via SimplifyDemandedVectorElts
330   APInt DemandedElts = possiblyDemandedEltsInMask(ConstMask);
331   APInt UndefElts(DemandedElts.getBitWidth(), 0);
332   if (Value *V =
333           SimplifyDemandedVectorElts(II.getOperand(0), DemandedElts, UndefElts))
334     return replaceOperand(II, 0, V);
335 
336   return nullptr;
337 }
338 
339 // TODO, Obvious Missing Transforms:
340 // * Single constant active lane load -> load
341 // * Dereferenceable address & few lanes -> scalarize speculative load/selects
342 // * Adjacent vector addresses -> masked.load
343 // * Narrow width by halfs excluding zero/undef lanes
344 // * Vector splat address w/known mask -> scalar load
345 // * Vector incrementing address -> vector masked load
346 Instruction *InstCombinerImpl::simplifyMaskedGather(IntrinsicInst &II) {
347   return nullptr;
348 }
349 
350 // TODO, Obvious Missing Transforms:
351 // * Single constant active lane -> store
352 // * Adjacent vector addresses -> masked.store
353 // * Narrow store width by halfs excluding zero/undef lanes
354 // * Vector splat address w/known mask -> scalar store
355 // * Vector incrementing address -> vector masked store
356 Instruction *InstCombinerImpl::simplifyMaskedScatter(IntrinsicInst &II) {
357   auto *ConstMask = dyn_cast<Constant>(II.getArgOperand(3));
358   if (!ConstMask)
359     return nullptr;
360 
361   // If the mask is all zeros, a scatter does nothing.
362   if (ConstMask->isNullValue())
363     return eraseInstFromFunction(II);
364 
365   if (isa<ScalableVectorType>(ConstMask->getType()))
366     return nullptr;
367 
368   // Use masked off lanes to simplify operands via SimplifyDemandedVectorElts
369   APInt DemandedElts = possiblyDemandedEltsInMask(ConstMask);
370   APInt UndefElts(DemandedElts.getBitWidth(), 0);
371   if (Value *V =
372           SimplifyDemandedVectorElts(II.getOperand(0), DemandedElts, UndefElts))
373     return replaceOperand(II, 0, V);
374   if (Value *V =
375           SimplifyDemandedVectorElts(II.getOperand(1), DemandedElts, UndefElts))
376     return replaceOperand(II, 1, V);
377 
378   return nullptr;
379 }
380 
381 /// This function transforms launder.invariant.group and strip.invariant.group
382 /// like:
383 /// launder(launder(%x)) -> launder(%x)       (the result is not the argument)
384 /// launder(strip(%x)) -> launder(%x)
385 /// strip(strip(%x)) -> strip(%x)             (the result is not the argument)
386 /// strip(launder(%x)) -> strip(%x)
387 /// This is legal because it preserves the most recent information about
388 /// the presence or absence of invariant.group.
389 static Instruction *simplifyInvariantGroupIntrinsic(IntrinsicInst &II,
390                                                     InstCombinerImpl &IC) {
391   auto *Arg = II.getArgOperand(0);
392   auto *StrippedArg = Arg->stripPointerCasts();
393   auto *StrippedInvariantGroupsArg = StrippedArg;
394   while (auto *Intr = dyn_cast<IntrinsicInst>(StrippedInvariantGroupsArg)) {
395     if (Intr->getIntrinsicID() != Intrinsic::launder_invariant_group &&
396         Intr->getIntrinsicID() != Intrinsic::strip_invariant_group)
397       break;
398     StrippedInvariantGroupsArg = Intr->getArgOperand(0)->stripPointerCasts();
399   }
400   if (StrippedArg == StrippedInvariantGroupsArg)
401     return nullptr; // No launders/strips to remove.
402 
403   Value *Result = nullptr;
404 
405   if (II.getIntrinsicID() == Intrinsic::launder_invariant_group)
406     Result = IC.Builder.CreateLaunderInvariantGroup(StrippedInvariantGroupsArg);
407   else if (II.getIntrinsicID() == Intrinsic::strip_invariant_group)
408     Result = IC.Builder.CreateStripInvariantGroup(StrippedInvariantGroupsArg);
409   else
410     llvm_unreachable(
411         "simplifyInvariantGroupIntrinsic only handles launder and strip");
412   if (Result->getType()->getPointerAddressSpace() !=
413       II.getType()->getPointerAddressSpace())
414     Result = IC.Builder.CreateAddrSpaceCast(Result, II.getType());
415   if (Result->getType() != II.getType())
416     Result = IC.Builder.CreateBitCast(Result, II.getType());
417 
418   return cast<Instruction>(Result);
419 }
420 
421 static Instruction *foldCttzCtlz(IntrinsicInst &II, InstCombinerImpl &IC) {
422   assert((II.getIntrinsicID() == Intrinsic::cttz ||
423           II.getIntrinsicID() == Intrinsic::ctlz) &&
424          "Expected cttz or ctlz intrinsic");
425   bool IsTZ = II.getIntrinsicID() == Intrinsic::cttz;
426   Value *Op0 = II.getArgOperand(0);
427   Value *X;
428   // ctlz(bitreverse(x)) -> cttz(x)
429   // cttz(bitreverse(x)) -> ctlz(x)
430   if (match(Op0, m_BitReverse(m_Value(X)))) {
431     Intrinsic::ID ID = IsTZ ? Intrinsic::ctlz : Intrinsic::cttz;
432     Function *F = Intrinsic::getDeclaration(II.getModule(), ID, II.getType());
433     return CallInst::Create(F, {X, II.getArgOperand(1)});
434   }
435 
436   if (IsTZ) {
437     // cttz(-x) -> cttz(x)
438     if (match(Op0, m_Neg(m_Value(X))))
439       return IC.replaceOperand(II, 0, X);
440 
441     // cttz(abs(x)) -> cttz(x)
442     // cttz(nabs(x)) -> cttz(x)
443     Value *Y;
444     SelectPatternFlavor SPF = matchSelectPattern(Op0, X, Y).Flavor;
445     if (SPF == SPF_ABS || SPF == SPF_NABS)
446       return IC.replaceOperand(II, 0, X);
447 
448     if (match(Op0, m_Intrinsic<Intrinsic::abs>(m_Value(X))))
449       return IC.replaceOperand(II, 0, X);
450   }
451 
452   KnownBits Known = IC.computeKnownBits(Op0, 0, &II);
453 
454   // Create a mask for bits above (ctlz) or below (cttz) the first known one.
455   unsigned PossibleZeros = IsTZ ? Known.countMaxTrailingZeros()
456                                 : Known.countMaxLeadingZeros();
457   unsigned DefiniteZeros = IsTZ ? Known.countMinTrailingZeros()
458                                 : Known.countMinLeadingZeros();
459 
460   // If all bits above (ctlz) or below (cttz) the first known one are known
461   // zero, this value is constant.
462   // FIXME: This should be in InstSimplify because we're replacing an
463   // instruction with a constant.
464   if (PossibleZeros == DefiniteZeros) {
465     auto *C = ConstantInt::get(Op0->getType(), DefiniteZeros);
466     return IC.replaceInstUsesWith(II, C);
467   }
468 
469   // If the input to cttz/ctlz is known to be non-zero,
470   // then change the 'ZeroIsUndef' parameter to 'true'
471   // because we know the zero behavior can't affect the result.
472   if (!Known.One.isNullValue() ||
473       isKnownNonZero(Op0, IC.getDataLayout(), 0, &IC.getAssumptionCache(), &II,
474                      &IC.getDominatorTree())) {
475     if (!match(II.getArgOperand(1), m_One()))
476       return IC.replaceOperand(II, 1, IC.Builder.getTrue());
477   }
478 
479   // Add range metadata since known bits can't completely reflect what we know.
480   // TODO: Handle splat vectors.
481   auto *IT = dyn_cast<IntegerType>(Op0->getType());
482   if (IT && IT->getBitWidth() != 1 && !II.getMetadata(LLVMContext::MD_range)) {
483     Metadata *LowAndHigh[] = {
484         ConstantAsMetadata::get(ConstantInt::get(IT, DefiniteZeros)),
485         ConstantAsMetadata::get(ConstantInt::get(IT, PossibleZeros + 1))};
486     II.setMetadata(LLVMContext::MD_range,
487                    MDNode::get(II.getContext(), LowAndHigh));
488     return &II;
489   }
490 
491   return nullptr;
492 }
493 
494 static Instruction *foldCtpop(IntrinsicInst &II, InstCombinerImpl &IC) {
495   assert(II.getIntrinsicID() == Intrinsic::ctpop &&
496          "Expected ctpop intrinsic");
497   Type *Ty = II.getType();
498   unsigned BitWidth = Ty->getScalarSizeInBits();
499   Value *Op0 = II.getArgOperand(0);
500   Value *X;
501 
502   // ctpop(bitreverse(x)) -> ctpop(x)
503   // ctpop(bswap(x)) -> ctpop(x)
504   if (match(Op0, m_BitReverse(m_Value(X))) || match(Op0, m_BSwap(m_Value(X))))
505     return IC.replaceOperand(II, 0, X);
506 
507   // ctpop(x | -x) -> bitwidth - cttz(x, false)
508   if (Op0->hasOneUse() &&
509       match(Op0, m_c_Or(m_Value(X), m_Neg(m_Deferred(X))))) {
510     Function *F =
511         Intrinsic::getDeclaration(II.getModule(), Intrinsic::cttz, Ty);
512     auto *Cttz = IC.Builder.CreateCall(F, {X, IC.Builder.getFalse()});
513     auto *Bw = ConstantInt::get(Ty, APInt(BitWidth, BitWidth));
514     return IC.replaceInstUsesWith(II, IC.Builder.CreateSub(Bw, Cttz));
515   }
516 
517   // ctpop(~x & (x - 1)) -> cttz(x, false)
518   if (match(Op0,
519             m_c_And(m_Not(m_Value(X)), m_Add(m_Deferred(X), m_AllOnes())))) {
520     Function *F =
521         Intrinsic::getDeclaration(II.getModule(), Intrinsic::cttz, Ty);
522     return CallInst::Create(F, {X, IC.Builder.getFalse()});
523   }
524 
525   // FIXME: Try to simplify vectors of integers.
526   auto *IT = dyn_cast<IntegerType>(Ty);
527   if (!IT)
528     return nullptr;
529 
530   KnownBits Known(BitWidth);
531   IC.computeKnownBits(Op0, Known, 0, &II);
532 
533   unsigned MinCount = Known.countMinPopulation();
534   unsigned MaxCount = Known.countMaxPopulation();
535 
536   // Add range metadata since known bits can't completely reflect what we know.
537   if (IT->getBitWidth() != 1 && !II.getMetadata(LLVMContext::MD_range)) {
538     Metadata *LowAndHigh[] = {
539         ConstantAsMetadata::get(ConstantInt::get(IT, MinCount)),
540         ConstantAsMetadata::get(ConstantInt::get(IT, MaxCount + 1))};
541     II.setMetadata(LLVMContext::MD_range,
542                    MDNode::get(II.getContext(), LowAndHigh));
543     return &II;
544   }
545 
546   return nullptr;
547 }
548 
549 /// Convert a table lookup to shufflevector if the mask is constant.
550 /// This could benefit tbl1 if the mask is { 7,6,5,4,3,2,1,0 }, in
551 /// which case we could lower the shufflevector with rev64 instructions
552 /// as it's actually a byte reverse.
553 static Value *simplifyNeonTbl1(const IntrinsicInst &II,
554                                InstCombiner::BuilderTy &Builder) {
555   // Bail out if the mask is not a constant.
556   auto *C = dyn_cast<Constant>(II.getArgOperand(1));
557   if (!C)
558     return nullptr;
559 
560   auto *VecTy = cast<FixedVectorType>(II.getType());
561   unsigned NumElts = VecTy->getNumElements();
562 
563   // Only perform this transformation for <8 x i8> vector types.
564   if (!VecTy->getElementType()->isIntegerTy(8) || NumElts != 8)
565     return nullptr;
566 
567   int Indexes[8];
568 
569   for (unsigned I = 0; I < NumElts; ++I) {
570     Constant *COp = C->getAggregateElement(I);
571 
572     if (!COp || !isa<ConstantInt>(COp))
573       return nullptr;
574 
575     Indexes[I] = cast<ConstantInt>(COp)->getLimitedValue();
576 
577     // Make sure the mask indices are in range.
578     if ((unsigned)Indexes[I] >= NumElts)
579       return nullptr;
580   }
581 
582   auto *V1 = II.getArgOperand(0);
583   auto *V2 = Constant::getNullValue(V1->getType());
584   return Builder.CreateShuffleVector(V1, V2, makeArrayRef(Indexes));
585 }
586 
587 // Returns true iff the 2 intrinsics have the same operands, limiting the
588 // comparison to the first NumOperands.
589 static bool haveSameOperands(const IntrinsicInst &I, const IntrinsicInst &E,
590                              unsigned NumOperands) {
591   assert(I.getNumArgOperands() >= NumOperands && "Not enough operands");
592   assert(E.getNumArgOperands() >= NumOperands && "Not enough operands");
593   for (unsigned i = 0; i < NumOperands; i++)
594     if (I.getArgOperand(i) != E.getArgOperand(i))
595       return false;
596   return true;
597 }
598 
599 // Remove trivially empty start/end intrinsic ranges, i.e. a start
600 // immediately followed by an end (ignoring debuginfo or other
601 // start/end intrinsics in between). As this handles only the most trivial
602 // cases, tracking the nesting level is not needed:
603 //
604 //   call @llvm.foo.start(i1 0)
605 //   call @llvm.foo.start(i1 0) ; This one won't be skipped: it will be removed
606 //   call @llvm.foo.end(i1 0)
607 //   call @llvm.foo.end(i1 0) ; &I
608 static bool
609 removeTriviallyEmptyRange(IntrinsicInst &EndI, InstCombinerImpl &IC,
610                           std::function<bool(const IntrinsicInst &)> IsStart) {
611   // We start from the end intrinsic and scan backwards, so that InstCombine
612   // has already processed (and potentially removed) all the instructions
613   // before the end intrinsic.
614   BasicBlock::reverse_iterator BI(EndI), BE(EndI.getParent()->rend());
615   for (; BI != BE; ++BI) {
616     if (auto *I = dyn_cast<IntrinsicInst>(&*BI)) {
617       if (isa<DbgInfoIntrinsic>(I) ||
618           I->getIntrinsicID() == EndI.getIntrinsicID())
619         continue;
620       if (IsStart(*I)) {
621         if (haveSameOperands(EndI, *I, EndI.getNumArgOperands())) {
622           IC.eraseInstFromFunction(*I);
623           IC.eraseInstFromFunction(EndI);
624           return true;
625         }
626         // Skip start intrinsics that don't pair with this end intrinsic.
627         continue;
628       }
629     }
630     break;
631   }
632 
633   return false;
634 }
635 
636 Instruction *InstCombinerImpl::visitVAEndInst(VAEndInst &I) {
637   removeTriviallyEmptyRange(I, *this, [](const IntrinsicInst &I) {
638     return I.getIntrinsicID() == Intrinsic::vastart ||
639            I.getIntrinsicID() == Intrinsic::vacopy;
640   });
641   return nullptr;
642 }
643 
644 static CallInst *canonicalizeConstantArg0ToArg1(CallInst &Call) {
645   assert(Call.getNumArgOperands() > 1 && "Need at least 2 args to swap");
646   Value *Arg0 = Call.getArgOperand(0), *Arg1 = Call.getArgOperand(1);
647   if (isa<Constant>(Arg0) && !isa<Constant>(Arg1)) {
648     Call.setArgOperand(0, Arg1);
649     Call.setArgOperand(1, Arg0);
650     return &Call;
651   }
652   return nullptr;
653 }
654 
655 /// Creates a result tuple for an overflow intrinsic \p II with a given
656 /// \p Result and a constant \p Overflow value.
657 static Instruction *createOverflowTuple(IntrinsicInst *II, Value *Result,
658                                         Constant *Overflow) {
659   Constant *V[] = {UndefValue::get(Result->getType()), Overflow};
660   StructType *ST = cast<StructType>(II->getType());
661   Constant *Struct = ConstantStruct::get(ST, V);
662   return InsertValueInst::Create(Struct, Result, 0);
663 }
664 
665 Instruction *
666 InstCombinerImpl::foldIntrinsicWithOverflowCommon(IntrinsicInst *II) {
667   WithOverflowInst *WO = cast<WithOverflowInst>(II);
668   Value *OperationResult = nullptr;
669   Constant *OverflowResult = nullptr;
670   if (OptimizeOverflowCheck(WO->getBinaryOp(), WO->isSigned(), WO->getLHS(),
671                             WO->getRHS(), *WO, OperationResult, OverflowResult))
672     return createOverflowTuple(WO, OperationResult, OverflowResult);
673   return nullptr;
674 }
675 
676 static Optional<bool> getKnownSign(Value *Op, Instruction *CxtI,
677                                    const DataLayout &DL, AssumptionCache *AC,
678                                    DominatorTree *DT) {
679   KnownBits Known = computeKnownBits(Op, DL, 0, AC, CxtI, DT);
680   if (Known.isNonNegative())
681     return false;
682   if (Known.isNegative())
683     return true;
684 
685   return isImpliedByDomCondition(
686       ICmpInst::ICMP_SLT, Op, Constant::getNullValue(Op->getType()), CxtI, DL);
687 }
688 
689 /// CallInst simplification. This mostly only handles folding of intrinsic
690 /// instructions. For normal calls, it allows visitCallBase to do the heavy
691 /// lifting.
692 Instruction *InstCombinerImpl::visitCallInst(CallInst &CI) {
693   // Don't try to simplify calls without uses. It will not do anything useful,
694   // but will result in the following folds being skipped.
695   if (!CI.use_empty())
696     if (Value *V = SimplifyCall(&CI, SQ.getWithInstruction(&CI)))
697       return replaceInstUsesWith(CI, V);
698 
699   if (isFreeCall(&CI, &TLI))
700     return visitFree(CI);
701 
702   // If the caller function is nounwind, mark the call as nounwind, even if the
703   // callee isn't.
704   if (CI.getFunction()->doesNotThrow() && !CI.doesNotThrow()) {
705     CI.setDoesNotThrow();
706     return &CI;
707   }
708 
709   IntrinsicInst *II = dyn_cast<IntrinsicInst>(&CI);
710   if (!II) return visitCallBase(CI);
711 
712   // For atomic unordered mem intrinsics if len is not a positive or
713   // not a multiple of element size then behavior is undefined.
714   if (auto *AMI = dyn_cast<AtomicMemIntrinsic>(II))
715     if (ConstantInt *NumBytes = dyn_cast<ConstantInt>(AMI->getLength()))
716       if (NumBytes->getSExtValue() < 0 ||
717           (NumBytes->getZExtValue() % AMI->getElementSizeInBytes() != 0)) {
718         CreateNonTerminatorUnreachable(AMI);
719         assert(AMI->getType()->isVoidTy() &&
720                "non void atomic unordered mem intrinsic");
721         return eraseInstFromFunction(*AMI);
722       }
723 
724   // Intrinsics cannot occur in an invoke or a callbr, so handle them here
725   // instead of in visitCallBase.
726   if (auto *MI = dyn_cast<AnyMemIntrinsic>(II)) {
727     bool Changed = false;
728 
729     // memmove/cpy/set of zero bytes is a noop.
730     if (Constant *NumBytes = dyn_cast<Constant>(MI->getLength())) {
731       if (NumBytes->isNullValue())
732         return eraseInstFromFunction(CI);
733 
734       if (ConstantInt *CI = dyn_cast<ConstantInt>(NumBytes))
735         if (CI->getZExtValue() == 1) {
736           // Replace the instruction with just byte operations.  We would
737           // transform other cases to loads/stores, but we don't know if
738           // alignment is sufficient.
739         }
740     }
741 
742     // No other transformations apply to volatile transfers.
743     if (auto *M = dyn_cast<MemIntrinsic>(MI))
744       if (M->isVolatile())
745         return nullptr;
746 
747     // If we have a memmove and the source operation is a constant global,
748     // then the source and dest pointers can't alias, so we can change this
749     // into a call to memcpy.
750     if (auto *MMI = dyn_cast<AnyMemMoveInst>(MI)) {
751       if (GlobalVariable *GVSrc = dyn_cast<GlobalVariable>(MMI->getSource()))
752         if (GVSrc->isConstant()) {
753           Module *M = CI.getModule();
754           Intrinsic::ID MemCpyID =
755               isa<AtomicMemMoveInst>(MMI)
756                   ? Intrinsic::memcpy_element_unordered_atomic
757                   : Intrinsic::memcpy;
758           Type *Tys[3] = { CI.getArgOperand(0)->getType(),
759                            CI.getArgOperand(1)->getType(),
760                            CI.getArgOperand(2)->getType() };
761           CI.setCalledFunction(Intrinsic::getDeclaration(M, MemCpyID, Tys));
762           Changed = true;
763         }
764     }
765 
766     if (AnyMemTransferInst *MTI = dyn_cast<AnyMemTransferInst>(MI)) {
767       // memmove(x,x,size) -> noop.
768       if (MTI->getSource() == MTI->getDest())
769         return eraseInstFromFunction(CI);
770     }
771 
772     // If we can determine a pointer alignment that is bigger than currently
773     // set, update the alignment.
774     if (auto *MTI = dyn_cast<AnyMemTransferInst>(MI)) {
775       if (Instruction *I = SimplifyAnyMemTransfer(MTI))
776         return I;
777     } else if (auto *MSI = dyn_cast<AnyMemSetInst>(MI)) {
778       if (Instruction *I = SimplifyAnyMemSet(MSI))
779         return I;
780     }
781 
782     if (Changed) return II;
783   }
784 
785   // For fixed width vector result intrinsics, use the generic demanded vector
786   // support.
787   if (auto *IIFVTy = dyn_cast<FixedVectorType>(II->getType())) {
788     auto VWidth = IIFVTy->getNumElements();
789     APInt UndefElts(VWidth, 0);
790     APInt AllOnesEltMask(APInt::getAllOnesValue(VWidth));
791     if (Value *V = SimplifyDemandedVectorElts(II, AllOnesEltMask, UndefElts)) {
792       if (V != II)
793         return replaceInstUsesWith(*II, V);
794       return II;
795     }
796   }
797 
798   if (II->isCommutative()) {
799     if (CallInst *NewCall = canonicalizeConstantArg0ToArg1(CI))
800       return NewCall;
801   }
802 
803   Intrinsic::ID IID = II->getIntrinsicID();
804   switch (IID) {
805   case Intrinsic::objectsize:
806     if (Value *V = lowerObjectSizeCall(II, DL, &TLI, /*MustSucceed=*/false))
807       return replaceInstUsesWith(CI, V);
808     return nullptr;
809   case Intrinsic::abs: {
810     Value *IIOperand = II->getArgOperand(0);
811     bool IntMinIsPoison = cast<Constant>(II->getArgOperand(1))->isOneValue();
812 
813     // abs(-x) -> abs(x)
814     // TODO: Copy nsw if it was present on the neg?
815     Value *X;
816     if (match(IIOperand, m_Neg(m_Value(X))))
817       return replaceOperand(*II, 0, X);
818     if (match(IIOperand, m_Select(m_Value(), m_Value(X), m_Neg(m_Deferred(X)))))
819       return replaceOperand(*II, 0, X);
820     if (match(IIOperand, m_Select(m_Value(), m_Neg(m_Value(X)), m_Deferred(X))))
821       return replaceOperand(*II, 0, X);
822 
823     if (Optional<bool> Sign = getKnownSign(IIOperand, II, DL, &AC, &DT)) {
824       // abs(x) -> x if x >= 0
825       if (!*Sign)
826         return replaceInstUsesWith(*II, IIOperand);
827 
828       // abs(x) -> -x if x < 0
829       if (IntMinIsPoison)
830         return BinaryOperator::CreateNSWNeg(IIOperand);
831       return BinaryOperator::CreateNeg(IIOperand);
832     }
833 
834     // abs (sext X) --> zext (abs X*)
835     // Clear the IsIntMin (nsw) bit on the abs to allow narrowing.
836     if (match(IIOperand, m_OneUse(m_SExt(m_Value(X))))) {
837       Value *NarrowAbs =
838           Builder.CreateBinaryIntrinsic(Intrinsic::abs, X, Builder.getFalse());
839       return CastInst::Create(Instruction::ZExt, NarrowAbs, II->getType());
840     }
841 
842     break;
843   }
844   case Intrinsic::umax:
845   case Intrinsic::umin: {
846     Value *I0 = II->getArgOperand(0), *I1 = II->getArgOperand(1);
847     Value *X, *Y;
848     if (match(I0, m_ZExt(m_Value(X))) && match(I1, m_ZExt(m_Value(Y))) &&
849         (I0->hasOneUse() || I1->hasOneUse()) && X->getType() == Y->getType()) {
850       Value *NarrowMaxMin = Builder.CreateBinaryIntrinsic(IID, X, Y);
851       return CastInst::Create(Instruction::ZExt, NarrowMaxMin, II->getType());
852     }
853     Constant *C;
854     if (match(I0, m_ZExt(m_Value(X))) && match(I1, m_Constant(C)) &&
855         I0->hasOneUse()) {
856       Constant *NarrowC = ConstantExpr::getTrunc(C, X->getType());
857       if (ConstantExpr::getZExt(NarrowC, II->getType()) == C) {
858         Value *NarrowMaxMin = Builder.CreateBinaryIntrinsic(IID, X, NarrowC);
859         return CastInst::Create(Instruction::ZExt, NarrowMaxMin, II->getType());
860       }
861     }
862     // If both operands of unsigned min/max are sign-extended, it is still ok
863     // to narrow the operation.
864     LLVM_FALLTHROUGH;
865   }
866   case Intrinsic::smax:
867   case Intrinsic::smin: {
868     Value *I0 = II->getArgOperand(0), *I1 = II->getArgOperand(1);
869     Value *X, *Y;
870     if (match(I0, m_SExt(m_Value(X))) && match(I1, m_SExt(m_Value(Y))) &&
871         (I0->hasOneUse() || I1->hasOneUse()) && X->getType() == Y->getType()) {
872       Value *NarrowMaxMin = Builder.CreateBinaryIntrinsic(IID, X, Y);
873       return CastInst::Create(Instruction::SExt, NarrowMaxMin, II->getType());
874     }
875     Constant *C;
876     if (match(I0, m_SExt(m_Value(X))) && match(I1, m_Constant(C)) &&
877         I0->hasOneUse()) {
878       Constant *NarrowC = ConstantExpr::getTrunc(C, X->getType());
879       if (ConstantExpr::getSExt(NarrowC, II->getType()) == C) {
880         Value *NarrowMaxMin = Builder.CreateBinaryIntrinsic(IID, X, NarrowC);
881         return CastInst::Create(Instruction::SExt, NarrowMaxMin, II->getType());
882       }
883     }
884     break;
885   }
886   case Intrinsic::bswap: {
887     Value *IIOperand = II->getArgOperand(0);
888     Value *X = nullptr;
889 
890     // bswap(trunc(bswap(x))) -> trunc(lshr(x, c))
891     if (match(IIOperand, m_Trunc(m_BSwap(m_Value(X))))) {
892       unsigned C = X->getType()->getScalarSizeInBits() -
893                    IIOperand->getType()->getScalarSizeInBits();
894       Value *CV = ConstantInt::get(X->getType(), C);
895       Value *V = Builder.CreateLShr(X, CV);
896       return new TruncInst(V, IIOperand->getType());
897     }
898     break;
899   }
900   case Intrinsic::masked_load:
901     if (Value *SimplifiedMaskedOp = simplifyMaskedLoad(*II))
902       return replaceInstUsesWith(CI, SimplifiedMaskedOp);
903     break;
904   case Intrinsic::masked_store:
905     return simplifyMaskedStore(*II);
906   case Intrinsic::masked_gather:
907     return simplifyMaskedGather(*II);
908   case Intrinsic::masked_scatter:
909     return simplifyMaskedScatter(*II);
910   case Intrinsic::launder_invariant_group:
911   case Intrinsic::strip_invariant_group:
912     if (auto *SkippedBarrier = simplifyInvariantGroupIntrinsic(*II, *this))
913       return replaceInstUsesWith(*II, SkippedBarrier);
914     break;
915   case Intrinsic::powi:
916     if (ConstantInt *Power = dyn_cast<ConstantInt>(II->getArgOperand(1))) {
917       // 0 and 1 are handled in instsimplify
918       // powi(x, -1) -> 1/x
919       if (Power->isMinusOne())
920         return BinaryOperator::CreateFDivFMF(ConstantFP::get(CI.getType(), 1.0),
921                                              II->getArgOperand(0), II);
922       // powi(x, 2) -> x*x
923       if (Power->equalsInt(2))
924         return BinaryOperator::CreateFMulFMF(II->getArgOperand(0),
925                                              II->getArgOperand(0), II);
926     }
927     break;
928 
929   case Intrinsic::cttz:
930   case Intrinsic::ctlz:
931     if (auto *I = foldCttzCtlz(*II, *this))
932       return I;
933     break;
934 
935   case Intrinsic::ctpop:
936     if (auto *I = foldCtpop(*II, *this))
937       return I;
938     break;
939 
940   case Intrinsic::fshl:
941   case Intrinsic::fshr: {
942     Value *Op0 = II->getArgOperand(0), *Op1 = II->getArgOperand(1);
943     Type *Ty = II->getType();
944     unsigned BitWidth = Ty->getScalarSizeInBits();
945     Constant *ShAmtC;
946     if (match(II->getArgOperand(2), m_ImmConstant(ShAmtC)) &&
947         !ShAmtC->containsConstantExpression()) {
948       // Canonicalize a shift amount constant operand to modulo the bit-width.
949       Constant *WidthC = ConstantInt::get(Ty, BitWidth);
950       Constant *ModuloC = ConstantExpr::getURem(ShAmtC, WidthC);
951       if (ModuloC != ShAmtC)
952         return replaceOperand(*II, 2, ModuloC);
953 
954       assert(ConstantExpr::getICmp(ICmpInst::ICMP_UGT, WidthC, ShAmtC) ==
955                  ConstantInt::getTrue(CmpInst::makeCmpResultType(Ty)) &&
956              "Shift amount expected to be modulo bitwidth");
957 
958       // Canonicalize funnel shift right by constant to funnel shift left. This
959       // is not entirely arbitrary. For historical reasons, the backend may
960       // recognize rotate left patterns but miss rotate right patterns.
961       if (IID == Intrinsic::fshr) {
962         // fshr X, Y, C --> fshl X, Y, (BitWidth - C)
963         Constant *LeftShiftC = ConstantExpr::getSub(WidthC, ShAmtC);
964         Module *Mod = II->getModule();
965         Function *Fshl = Intrinsic::getDeclaration(Mod, Intrinsic::fshl, Ty);
966         return CallInst::Create(Fshl, { Op0, Op1, LeftShiftC });
967       }
968       assert(IID == Intrinsic::fshl &&
969              "All funnel shifts by simple constants should go left");
970 
971       // fshl(X, 0, C) --> shl X, C
972       // fshl(X, undef, C) --> shl X, C
973       if (match(Op1, m_ZeroInt()) || match(Op1, m_Undef()))
974         return BinaryOperator::CreateShl(Op0, ShAmtC);
975 
976       // fshl(0, X, C) --> lshr X, (BW-C)
977       // fshl(undef, X, C) --> lshr X, (BW-C)
978       if (match(Op0, m_ZeroInt()) || match(Op0, m_Undef()))
979         return BinaryOperator::CreateLShr(Op1,
980                                           ConstantExpr::getSub(WidthC, ShAmtC));
981 
982       // fshl i16 X, X, 8 --> bswap i16 X (reduce to more-specific form)
983       if (Op0 == Op1 && BitWidth == 16 && match(ShAmtC, m_SpecificInt(8))) {
984         Module *Mod = II->getModule();
985         Function *Bswap = Intrinsic::getDeclaration(Mod, Intrinsic::bswap, Ty);
986         return CallInst::Create(Bswap, { Op0 });
987       }
988     }
989 
990     // Left or right might be masked.
991     if (SimplifyDemandedInstructionBits(*II))
992       return &CI;
993 
994     // The shift amount (operand 2) of a funnel shift is modulo the bitwidth,
995     // so only the low bits of the shift amount are demanded if the bitwidth is
996     // a power-of-2.
997     if (!isPowerOf2_32(BitWidth))
998       break;
999     APInt Op2Demanded = APInt::getLowBitsSet(BitWidth, Log2_32_Ceil(BitWidth));
1000     KnownBits Op2Known(BitWidth);
1001     if (SimplifyDemandedBits(II, 2, Op2Demanded, Op2Known))
1002       return &CI;
1003     break;
1004   }
1005   case Intrinsic::uadd_with_overflow:
1006   case Intrinsic::sadd_with_overflow: {
1007     if (Instruction *I = foldIntrinsicWithOverflowCommon(II))
1008       return I;
1009 
1010     // Given 2 constant operands whose sum does not overflow:
1011     // uaddo (X +nuw C0), C1 -> uaddo X, C0 + C1
1012     // saddo (X +nsw C0), C1 -> saddo X, C0 + C1
1013     Value *X;
1014     const APInt *C0, *C1;
1015     Value *Arg0 = II->getArgOperand(0);
1016     Value *Arg1 = II->getArgOperand(1);
1017     bool IsSigned = IID == Intrinsic::sadd_with_overflow;
1018     bool HasNWAdd = IsSigned ? match(Arg0, m_NSWAdd(m_Value(X), m_APInt(C0)))
1019                              : match(Arg0, m_NUWAdd(m_Value(X), m_APInt(C0)));
1020     if (HasNWAdd && match(Arg1, m_APInt(C1))) {
1021       bool Overflow;
1022       APInt NewC =
1023           IsSigned ? C1->sadd_ov(*C0, Overflow) : C1->uadd_ov(*C0, Overflow);
1024       if (!Overflow)
1025         return replaceInstUsesWith(
1026             *II, Builder.CreateBinaryIntrinsic(
1027                      IID, X, ConstantInt::get(Arg1->getType(), NewC)));
1028     }
1029     break;
1030   }
1031 
1032   case Intrinsic::umul_with_overflow:
1033   case Intrinsic::smul_with_overflow:
1034   case Intrinsic::usub_with_overflow:
1035     if (Instruction *I = foldIntrinsicWithOverflowCommon(II))
1036       return I;
1037     break;
1038 
1039   case Intrinsic::ssub_with_overflow: {
1040     if (Instruction *I = foldIntrinsicWithOverflowCommon(II))
1041       return I;
1042 
1043     Constant *C;
1044     Value *Arg0 = II->getArgOperand(0);
1045     Value *Arg1 = II->getArgOperand(1);
1046     // Given a constant C that is not the minimum signed value
1047     // for an integer of a given bit width:
1048     //
1049     // ssubo X, C -> saddo X, -C
1050     if (match(Arg1, m_Constant(C)) && C->isNotMinSignedValue()) {
1051       Value *NegVal = ConstantExpr::getNeg(C);
1052       // Build a saddo call that is equivalent to the discovered
1053       // ssubo call.
1054       return replaceInstUsesWith(
1055           *II, Builder.CreateBinaryIntrinsic(Intrinsic::sadd_with_overflow,
1056                                              Arg0, NegVal));
1057     }
1058 
1059     break;
1060   }
1061 
1062   case Intrinsic::uadd_sat:
1063   case Intrinsic::sadd_sat:
1064   case Intrinsic::usub_sat:
1065   case Intrinsic::ssub_sat: {
1066     SaturatingInst *SI = cast<SaturatingInst>(II);
1067     Type *Ty = SI->getType();
1068     Value *Arg0 = SI->getLHS();
1069     Value *Arg1 = SI->getRHS();
1070 
1071     // Make use of known overflow information.
1072     OverflowResult OR = computeOverflow(SI->getBinaryOp(), SI->isSigned(),
1073                                         Arg0, Arg1, SI);
1074     switch (OR) {
1075       case OverflowResult::MayOverflow:
1076         break;
1077       case OverflowResult::NeverOverflows:
1078         if (SI->isSigned())
1079           return BinaryOperator::CreateNSW(SI->getBinaryOp(), Arg0, Arg1);
1080         else
1081           return BinaryOperator::CreateNUW(SI->getBinaryOp(), Arg0, Arg1);
1082       case OverflowResult::AlwaysOverflowsLow: {
1083         unsigned BitWidth = Ty->getScalarSizeInBits();
1084         APInt Min = APSInt::getMinValue(BitWidth, !SI->isSigned());
1085         return replaceInstUsesWith(*SI, ConstantInt::get(Ty, Min));
1086       }
1087       case OverflowResult::AlwaysOverflowsHigh: {
1088         unsigned BitWidth = Ty->getScalarSizeInBits();
1089         APInt Max = APSInt::getMaxValue(BitWidth, !SI->isSigned());
1090         return replaceInstUsesWith(*SI, ConstantInt::get(Ty, Max));
1091       }
1092     }
1093 
1094     // ssub.sat(X, C) -> sadd.sat(X, -C) if C != MIN
1095     Constant *C;
1096     if (IID == Intrinsic::ssub_sat && match(Arg1, m_Constant(C)) &&
1097         C->isNotMinSignedValue()) {
1098       Value *NegVal = ConstantExpr::getNeg(C);
1099       return replaceInstUsesWith(
1100           *II, Builder.CreateBinaryIntrinsic(
1101               Intrinsic::sadd_sat, Arg0, NegVal));
1102     }
1103 
1104     // sat(sat(X + Val2) + Val) -> sat(X + (Val+Val2))
1105     // sat(sat(X - Val2) - Val) -> sat(X - (Val+Val2))
1106     // if Val and Val2 have the same sign
1107     if (auto *Other = dyn_cast<IntrinsicInst>(Arg0)) {
1108       Value *X;
1109       const APInt *Val, *Val2;
1110       APInt NewVal;
1111       bool IsUnsigned =
1112           IID == Intrinsic::uadd_sat || IID == Intrinsic::usub_sat;
1113       if (Other->getIntrinsicID() == IID &&
1114           match(Arg1, m_APInt(Val)) &&
1115           match(Other->getArgOperand(0), m_Value(X)) &&
1116           match(Other->getArgOperand(1), m_APInt(Val2))) {
1117         if (IsUnsigned)
1118           NewVal = Val->uadd_sat(*Val2);
1119         else if (Val->isNonNegative() == Val2->isNonNegative()) {
1120           bool Overflow;
1121           NewVal = Val->sadd_ov(*Val2, Overflow);
1122           if (Overflow) {
1123             // Both adds together may add more than SignedMaxValue
1124             // without saturating the final result.
1125             break;
1126           }
1127         } else {
1128           // Cannot fold saturated addition with different signs.
1129           break;
1130         }
1131 
1132         return replaceInstUsesWith(
1133             *II, Builder.CreateBinaryIntrinsic(
1134                      IID, X, ConstantInt::get(II->getType(), NewVal)));
1135       }
1136     }
1137     break;
1138   }
1139 
1140   case Intrinsic::minnum:
1141   case Intrinsic::maxnum:
1142   case Intrinsic::minimum:
1143   case Intrinsic::maximum: {
1144     Value *Arg0 = II->getArgOperand(0);
1145     Value *Arg1 = II->getArgOperand(1);
1146     Value *X, *Y;
1147     if (match(Arg0, m_FNeg(m_Value(X))) && match(Arg1, m_FNeg(m_Value(Y))) &&
1148         (Arg0->hasOneUse() || Arg1->hasOneUse())) {
1149       // If both operands are negated, invert the call and negate the result:
1150       // min(-X, -Y) --> -(max(X, Y))
1151       // max(-X, -Y) --> -(min(X, Y))
1152       Intrinsic::ID NewIID;
1153       switch (IID) {
1154       case Intrinsic::maxnum:
1155         NewIID = Intrinsic::minnum;
1156         break;
1157       case Intrinsic::minnum:
1158         NewIID = Intrinsic::maxnum;
1159         break;
1160       case Intrinsic::maximum:
1161         NewIID = Intrinsic::minimum;
1162         break;
1163       case Intrinsic::minimum:
1164         NewIID = Intrinsic::maximum;
1165         break;
1166       default:
1167         llvm_unreachable("unexpected intrinsic ID");
1168       }
1169       Value *NewCall = Builder.CreateBinaryIntrinsic(NewIID, X, Y, II);
1170       Instruction *FNeg = UnaryOperator::CreateFNeg(NewCall);
1171       FNeg->copyIRFlags(II);
1172       return FNeg;
1173     }
1174 
1175     // m(m(X, C2), C1) -> m(X, C)
1176     const APFloat *C1, *C2;
1177     if (auto *M = dyn_cast<IntrinsicInst>(Arg0)) {
1178       if (M->getIntrinsicID() == IID && match(Arg1, m_APFloat(C1)) &&
1179           ((match(M->getArgOperand(0), m_Value(X)) &&
1180             match(M->getArgOperand(1), m_APFloat(C2))) ||
1181            (match(M->getArgOperand(1), m_Value(X)) &&
1182             match(M->getArgOperand(0), m_APFloat(C2))))) {
1183         APFloat Res(0.0);
1184         switch (IID) {
1185         case Intrinsic::maxnum:
1186           Res = maxnum(*C1, *C2);
1187           break;
1188         case Intrinsic::minnum:
1189           Res = minnum(*C1, *C2);
1190           break;
1191         case Intrinsic::maximum:
1192           Res = maximum(*C1, *C2);
1193           break;
1194         case Intrinsic::minimum:
1195           Res = minimum(*C1, *C2);
1196           break;
1197         default:
1198           llvm_unreachable("unexpected intrinsic ID");
1199         }
1200         Instruction *NewCall = Builder.CreateBinaryIntrinsic(
1201             IID, X, ConstantFP::get(Arg0->getType(), Res), II);
1202         // TODO: Conservatively intersecting FMF. If Res == C2, the transform
1203         //       was a simplification (so Arg0 and its original flags could
1204         //       propagate?)
1205         NewCall->andIRFlags(M);
1206         return replaceInstUsesWith(*II, NewCall);
1207       }
1208     }
1209 
1210     Value *ExtSrc0;
1211     Value *ExtSrc1;
1212 
1213     // minnum (fpext x), (fpext y) -> minnum x, y
1214     // maxnum (fpext x), (fpext y) -> maxnum x, y
1215     if (match(II->getArgOperand(0), m_OneUse(m_FPExt(m_Value(ExtSrc0)))) &&
1216         match(II->getArgOperand(1), m_OneUse(m_FPExt(m_Value(ExtSrc1)))) &&
1217         ExtSrc0->getType() == ExtSrc1->getType()) {
1218       Function *F = Intrinsic::getDeclaration(
1219           II->getModule(), II->getIntrinsicID(), {ExtSrc0->getType()});
1220       CallInst *NewCall = Builder.CreateCall(F, { ExtSrc0, ExtSrc1 });
1221       NewCall->copyFastMathFlags(II);
1222       NewCall->takeName(II);
1223       return new FPExtInst(NewCall, II->getType());
1224     }
1225 
1226     break;
1227   }
1228   case Intrinsic::fmuladd: {
1229     // Canonicalize fast fmuladd to the separate fmul + fadd.
1230     if (II->isFast()) {
1231       BuilderTy::FastMathFlagGuard Guard(Builder);
1232       Builder.setFastMathFlags(II->getFastMathFlags());
1233       Value *Mul = Builder.CreateFMul(II->getArgOperand(0),
1234                                       II->getArgOperand(1));
1235       Value *Add = Builder.CreateFAdd(Mul, II->getArgOperand(2));
1236       Add->takeName(II);
1237       return replaceInstUsesWith(*II, Add);
1238     }
1239 
1240     // Try to simplify the underlying FMul.
1241     if (Value *V = SimplifyFMulInst(II->getArgOperand(0), II->getArgOperand(1),
1242                                     II->getFastMathFlags(),
1243                                     SQ.getWithInstruction(II))) {
1244       auto *FAdd = BinaryOperator::CreateFAdd(V, II->getArgOperand(2));
1245       FAdd->copyFastMathFlags(II);
1246       return FAdd;
1247     }
1248 
1249     LLVM_FALLTHROUGH;
1250   }
1251   case Intrinsic::fma: {
1252     // fma fneg(x), fneg(y), z -> fma x, y, z
1253     Value *Src0 = II->getArgOperand(0);
1254     Value *Src1 = II->getArgOperand(1);
1255     Value *X, *Y;
1256     if (match(Src0, m_FNeg(m_Value(X))) && match(Src1, m_FNeg(m_Value(Y)))) {
1257       replaceOperand(*II, 0, X);
1258       replaceOperand(*II, 1, Y);
1259       return II;
1260     }
1261 
1262     // fma fabs(x), fabs(x), z -> fma x, x, z
1263     if (match(Src0, m_FAbs(m_Value(X))) &&
1264         match(Src1, m_FAbs(m_Specific(X)))) {
1265       replaceOperand(*II, 0, X);
1266       replaceOperand(*II, 1, X);
1267       return II;
1268     }
1269 
1270     // Try to simplify the underlying FMul. We can only apply simplifications
1271     // that do not require rounding.
1272     if (Value *V = SimplifyFMAFMul(II->getArgOperand(0), II->getArgOperand(1),
1273                                    II->getFastMathFlags(),
1274                                    SQ.getWithInstruction(II))) {
1275       auto *FAdd = BinaryOperator::CreateFAdd(V, II->getArgOperand(2));
1276       FAdd->copyFastMathFlags(II);
1277       return FAdd;
1278     }
1279 
1280     // fma x, y, 0 -> fmul x, y
1281     // This is always valid for -0.0, but requires nsz for +0.0 as
1282     // -0.0 + 0.0 = 0.0, which would not be the same as the fmul on its own.
1283     if (match(II->getArgOperand(2), m_NegZeroFP()) ||
1284         (match(II->getArgOperand(2), m_PosZeroFP()) &&
1285          II->getFastMathFlags().noSignedZeros()))
1286       return BinaryOperator::CreateFMulFMF(Src0, Src1, II);
1287 
1288     break;
1289   }
1290   case Intrinsic::copysign: {
1291     Value *Mag = II->getArgOperand(0), *Sign = II->getArgOperand(1);
1292     if (SignBitMustBeZero(Sign, &TLI)) {
1293       // If we know that the sign argument is positive, reduce to FABS:
1294       // copysign Mag, +Sign --> fabs Mag
1295       Value *Fabs = Builder.CreateUnaryIntrinsic(Intrinsic::fabs, Mag, II);
1296       return replaceInstUsesWith(*II, Fabs);
1297     }
1298     // TODO: There should be a ValueTracking sibling like SignBitMustBeOne.
1299     const APFloat *C;
1300     if (match(Sign, m_APFloat(C)) && C->isNegative()) {
1301       // If we know that the sign argument is negative, reduce to FNABS:
1302       // copysign Mag, -Sign --> fneg (fabs Mag)
1303       Value *Fabs = Builder.CreateUnaryIntrinsic(Intrinsic::fabs, Mag, II);
1304       return replaceInstUsesWith(*II, Builder.CreateFNegFMF(Fabs, II));
1305     }
1306 
1307     // Propagate sign argument through nested calls:
1308     // copysign Mag, (copysign ?, X) --> copysign Mag, X
1309     Value *X;
1310     if (match(Sign, m_Intrinsic<Intrinsic::copysign>(m_Value(), m_Value(X))))
1311       return replaceOperand(*II, 1, X);
1312 
1313     // Peek through changes of magnitude's sign-bit. This call rewrites those:
1314     // copysign (fabs X), Sign --> copysign X, Sign
1315     // copysign (fneg X), Sign --> copysign X, Sign
1316     if (match(Mag, m_FAbs(m_Value(X))) || match(Mag, m_FNeg(m_Value(X))))
1317       return replaceOperand(*II, 0, X);
1318 
1319     break;
1320   }
1321   case Intrinsic::fabs: {
1322     Value *Cond, *TVal, *FVal;
1323     if (match(II->getArgOperand(0),
1324               m_Select(m_Value(Cond), m_Value(TVal), m_Value(FVal)))) {
1325       // fabs (select Cond, TrueC, FalseC) --> select Cond, AbsT, AbsF
1326       if (isa<Constant>(TVal) && isa<Constant>(FVal)) {
1327         CallInst *AbsT = Builder.CreateCall(II->getCalledFunction(), {TVal});
1328         CallInst *AbsF = Builder.CreateCall(II->getCalledFunction(), {FVal});
1329         return SelectInst::Create(Cond, AbsT, AbsF);
1330       }
1331       // fabs (select Cond, -FVal, FVal) --> fabs FVal
1332       if (match(TVal, m_FNeg(m_Specific(FVal))))
1333         return replaceOperand(*II, 0, FVal);
1334       // fabs (select Cond, TVal, -TVal) --> fabs TVal
1335       if (match(FVal, m_FNeg(m_Specific(TVal))))
1336         return replaceOperand(*II, 0, TVal);
1337     }
1338 
1339     LLVM_FALLTHROUGH;
1340   }
1341   case Intrinsic::ceil:
1342   case Intrinsic::floor:
1343   case Intrinsic::round:
1344   case Intrinsic::roundeven:
1345   case Intrinsic::nearbyint:
1346   case Intrinsic::rint:
1347   case Intrinsic::trunc: {
1348     Value *ExtSrc;
1349     if (match(II->getArgOperand(0), m_OneUse(m_FPExt(m_Value(ExtSrc))))) {
1350       // Narrow the call: intrinsic (fpext x) -> fpext (intrinsic x)
1351       Value *NarrowII = Builder.CreateUnaryIntrinsic(IID, ExtSrc, II);
1352       return new FPExtInst(NarrowII, II->getType());
1353     }
1354     break;
1355   }
1356   case Intrinsic::cos:
1357   case Intrinsic::amdgcn_cos: {
1358     Value *X;
1359     Value *Src = II->getArgOperand(0);
1360     if (match(Src, m_FNeg(m_Value(X))) || match(Src, m_FAbs(m_Value(X)))) {
1361       // cos(-x) -> cos(x)
1362       // cos(fabs(x)) -> cos(x)
1363       return replaceOperand(*II, 0, X);
1364     }
1365     break;
1366   }
1367   case Intrinsic::sin: {
1368     Value *X;
1369     if (match(II->getArgOperand(0), m_OneUse(m_FNeg(m_Value(X))))) {
1370       // sin(-x) --> -sin(x)
1371       Value *NewSin = Builder.CreateUnaryIntrinsic(Intrinsic::sin, X, II);
1372       Instruction *FNeg = UnaryOperator::CreateFNeg(NewSin);
1373       FNeg->copyFastMathFlags(II);
1374       return FNeg;
1375     }
1376     break;
1377   }
1378 
1379   case Intrinsic::arm_neon_vtbl1:
1380   case Intrinsic::aarch64_neon_tbl1:
1381     if (Value *V = simplifyNeonTbl1(*II, Builder))
1382       return replaceInstUsesWith(*II, V);
1383     break;
1384 
1385   case Intrinsic::arm_neon_vmulls:
1386   case Intrinsic::arm_neon_vmullu:
1387   case Intrinsic::aarch64_neon_smull:
1388   case Intrinsic::aarch64_neon_umull: {
1389     Value *Arg0 = II->getArgOperand(0);
1390     Value *Arg1 = II->getArgOperand(1);
1391 
1392     // Handle mul by zero first:
1393     if (isa<ConstantAggregateZero>(Arg0) || isa<ConstantAggregateZero>(Arg1)) {
1394       return replaceInstUsesWith(CI, ConstantAggregateZero::get(II->getType()));
1395     }
1396 
1397     // Check for constant LHS & RHS - in this case we just simplify.
1398     bool Zext = (IID == Intrinsic::arm_neon_vmullu ||
1399                  IID == Intrinsic::aarch64_neon_umull);
1400     VectorType *NewVT = cast<VectorType>(II->getType());
1401     if (Constant *CV0 = dyn_cast<Constant>(Arg0)) {
1402       if (Constant *CV1 = dyn_cast<Constant>(Arg1)) {
1403         CV0 = ConstantExpr::getIntegerCast(CV0, NewVT, /*isSigned=*/!Zext);
1404         CV1 = ConstantExpr::getIntegerCast(CV1, NewVT, /*isSigned=*/!Zext);
1405 
1406         return replaceInstUsesWith(CI, ConstantExpr::getMul(CV0, CV1));
1407       }
1408 
1409       // Couldn't simplify - canonicalize constant to the RHS.
1410       std::swap(Arg0, Arg1);
1411     }
1412 
1413     // Handle mul by one:
1414     if (Constant *CV1 = dyn_cast<Constant>(Arg1))
1415       if (ConstantInt *Splat =
1416               dyn_cast_or_null<ConstantInt>(CV1->getSplatValue()))
1417         if (Splat->isOne())
1418           return CastInst::CreateIntegerCast(Arg0, II->getType(),
1419                                              /*isSigned=*/!Zext);
1420 
1421     break;
1422   }
1423   case Intrinsic::arm_neon_aesd:
1424   case Intrinsic::arm_neon_aese:
1425   case Intrinsic::aarch64_crypto_aesd:
1426   case Intrinsic::aarch64_crypto_aese: {
1427     Value *DataArg = II->getArgOperand(0);
1428     Value *KeyArg  = II->getArgOperand(1);
1429 
1430     // Try to use the builtin XOR in AESE and AESD to eliminate a prior XOR
1431     Value *Data, *Key;
1432     if (match(KeyArg, m_ZeroInt()) &&
1433         match(DataArg, m_Xor(m_Value(Data), m_Value(Key)))) {
1434       replaceOperand(*II, 0, Data);
1435       replaceOperand(*II, 1, Key);
1436       return II;
1437     }
1438     break;
1439   }
1440   case Intrinsic::hexagon_V6_vandvrt:
1441   case Intrinsic::hexagon_V6_vandvrt_128B: {
1442     // Simplify Q -> V -> Q conversion.
1443     if (auto Op0 = dyn_cast<IntrinsicInst>(II->getArgOperand(0))) {
1444       Intrinsic::ID ID0 = Op0->getIntrinsicID();
1445       if (ID0 != Intrinsic::hexagon_V6_vandqrt &&
1446           ID0 != Intrinsic::hexagon_V6_vandqrt_128B)
1447         break;
1448       Value *Bytes = Op0->getArgOperand(1), *Mask = II->getArgOperand(1);
1449       uint64_t Bytes1 = computeKnownBits(Bytes, 0, Op0).One.getZExtValue();
1450       uint64_t Mask1 = computeKnownBits(Mask, 0, II).One.getZExtValue();
1451       // Check if every byte has common bits in Bytes and Mask.
1452       uint64_t C = Bytes1 & Mask1;
1453       if ((C & 0xFF) && (C & 0xFF00) && (C & 0xFF0000) && (C & 0xFF000000))
1454         return replaceInstUsesWith(*II, Op0->getArgOperand(0));
1455     }
1456     break;
1457   }
1458   case Intrinsic::stackrestore: {
1459     // If the save is right next to the restore, remove the restore.  This can
1460     // happen when variable allocas are DCE'd.
1461     if (IntrinsicInst *SS = dyn_cast<IntrinsicInst>(II->getArgOperand(0))) {
1462       if (SS->getIntrinsicID() == Intrinsic::stacksave) {
1463         // Skip over debug info.
1464         if (SS->getNextNonDebugInstruction() == II) {
1465           return eraseInstFromFunction(CI);
1466         }
1467       }
1468     }
1469 
1470     // Scan down this block to see if there is another stack restore in the
1471     // same block without an intervening call/alloca.
1472     BasicBlock::iterator BI(II);
1473     Instruction *TI = II->getParent()->getTerminator();
1474     bool CannotRemove = false;
1475     for (++BI; &*BI != TI; ++BI) {
1476       if (isa<AllocaInst>(BI)) {
1477         CannotRemove = true;
1478         break;
1479       }
1480       if (CallInst *BCI = dyn_cast<CallInst>(BI)) {
1481         if (auto *II2 = dyn_cast<IntrinsicInst>(BCI)) {
1482           // If there is a stackrestore below this one, remove this one.
1483           if (II2->getIntrinsicID() == Intrinsic::stackrestore)
1484             return eraseInstFromFunction(CI);
1485 
1486           // Bail if we cross over an intrinsic with side effects, such as
1487           // llvm.stacksave, or llvm.read_register.
1488           if (II2->mayHaveSideEffects()) {
1489             CannotRemove = true;
1490             break;
1491           }
1492         } else {
1493           // If we found a non-intrinsic call, we can't remove the stack
1494           // restore.
1495           CannotRemove = true;
1496           break;
1497         }
1498       }
1499     }
1500 
1501     // If the stack restore is in a return, resume, or unwind block and if there
1502     // are no allocas or calls between the restore and the return, nuke the
1503     // restore.
1504     if (!CannotRemove && (isa<ReturnInst>(TI) || isa<ResumeInst>(TI)))
1505       return eraseInstFromFunction(CI);
1506     break;
1507   }
1508   case Intrinsic::lifetime_end:
1509     // Asan needs to poison memory to detect invalid access which is possible
1510     // even for empty lifetime range.
1511     if (II->getFunction()->hasFnAttribute(Attribute::SanitizeAddress) ||
1512         II->getFunction()->hasFnAttribute(Attribute::SanitizeMemory) ||
1513         II->getFunction()->hasFnAttribute(Attribute::SanitizeHWAddress))
1514       break;
1515 
1516     if (removeTriviallyEmptyRange(*II, *this, [](const IntrinsicInst &I) {
1517           return I.getIntrinsicID() == Intrinsic::lifetime_start;
1518         }))
1519       return nullptr;
1520     break;
1521   case Intrinsic::assume: {
1522     Value *IIOperand = II->getArgOperand(0);
1523     SmallVector<OperandBundleDef, 4> OpBundles;
1524     II->getOperandBundlesAsDefs(OpBundles);
1525 
1526     /// This will remove the boolean Condition from the assume given as
1527     /// argument and remove the assume if it becomes useless.
1528     /// always returns nullptr for use as a return values.
1529     auto RemoveConditionFromAssume = [&](Instruction *Assume) -> Instruction * {
1530       assert(isa<IntrinsicInst>(Assume));
1531       if (isAssumeWithEmptyBundle(*cast<IntrinsicInst>(II)))
1532         return eraseInstFromFunction(CI);
1533       replaceUse(II->getOperandUse(0), ConstantInt::getTrue(II->getContext()));
1534       return nullptr;
1535     };
1536     // Remove an assume if it is followed by an identical assume.
1537     // TODO: Do we need this? Unless there are conflicting assumptions, the
1538     // computeKnownBits(IIOperand) below here eliminates redundant assumes.
1539     Instruction *Next = II->getNextNonDebugInstruction();
1540     if (match(Next, m_Intrinsic<Intrinsic::assume>(m_Specific(IIOperand))))
1541       return RemoveConditionFromAssume(Next);
1542 
1543     // Canonicalize assume(a && b) -> assume(a); assume(b);
1544     // Note: New assumption intrinsics created here are registered by
1545     // the InstCombineIRInserter object.
1546     FunctionType *AssumeIntrinsicTy = II->getFunctionType();
1547     Value *AssumeIntrinsic = II->getCalledOperand();
1548     Value *A, *B;
1549     if (match(IIOperand, m_LogicalAnd(m_Value(A), m_Value(B)))) {
1550       Builder.CreateCall(AssumeIntrinsicTy, AssumeIntrinsic, A, OpBundles,
1551                          II->getName());
1552       Builder.CreateCall(AssumeIntrinsicTy, AssumeIntrinsic, B, II->getName());
1553       return eraseInstFromFunction(*II);
1554     }
1555     // assume(!(a || b)) -> assume(!a); assume(!b);
1556     if (match(IIOperand, m_Not(m_LogicalOr(m_Value(A), m_Value(B))))) {
1557       Builder.CreateCall(AssumeIntrinsicTy, AssumeIntrinsic,
1558                          Builder.CreateNot(A), OpBundles, II->getName());
1559       Builder.CreateCall(AssumeIntrinsicTy, AssumeIntrinsic,
1560                          Builder.CreateNot(B), II->getName());
1561       return eraseInstFromFunction(*II);
1562     }
1563 
1564     // assume( (load addr) != null ) -> add 'nonnull' metadata to load
1565     // (if assume is valid at the load)
1566     CmpInst::Predicate Pred;
1567     Instruction *LHS;
1568     if (match(IIOperand, m_ICmp(Pred, m_Instruction(LHS), m_Zero())) &&
1569         Pred == ICmpInst::ICMP_NE && LHS->getOpcode() == Instruction::Load &&
1570         LHS->getType()->isPointerTy() &&
1571         isValidAssumeForContext(II, LHS, &DT)) {
1572       MDNode *MD = MDNode::get(II->getContext(), None);
1573       LHS->setMetadata(LLVMContext::MD_nonnull, MD);
1574       return RemoveConditionFromAssume(II);
1575 
1576       // TODO: apply nonnull return attributes to calls and invokes
1577       // TODO: apply range metadata for range check patterns?
1578     }
1579 
1580     // Convert nonnull assume like:
1581     // %A = icmp ne i32* %PTR, null
1582     // call void @llvm.assume(i1 %A)
1583     // into
1584     // call void @llvm.assume(i1 true) [ "nonnull"(i32* %PTR) ]
1585     if (EnableKnowledgeRetention &&
1586         match(IIOperand, m_Cmp(Pred, m_Value(A), m_Zero())) &&
1587         Pred == CmpInst::ICMP_NE && A->getType()->isPointerTy()) {
1588       if (IntrinsicInst *Replacement = buildAssumeFromKnowledge(
1589               {RetainedKnowledge{Attribute::NonNull, 0, A}}, Next, &AC, &DT)) {
1590 
1591         Replacement->insertBefore(Next);
1592         AC.registerAssumption(Replacement);
1593         return RemoveConditionFromAssume(II);
1594       }
1595     }
1596 
1597     // Convert alignment assume like:
1598     // %B = ptrtoint i32* %A to i64
1599     // %C = and i64 %B, Constant
1600     // %D = icmp eq i64 %C, 0
1601     // call void @llvm.assume(i1 %D)
1602     // into
1603     // call void @llvm.assume(i1 true) [ "align"(i32* [[A]], i64  Constant + 1)]
1604     uint64_t AlignMask;
1605     if (EnableKnowledgeRetention &&
1606         match(IIOperand,
1607               m_Cmp(Pred, m_And(m_Value(A), m_ConstantInt(AlignMask)),
1608                     m_Zero())) &&
1609         Pred == CmpInst::ICMP_EQ) {
1610       if (isPowerOf2_64(AlignMask + 1)) {
1611         uint64_t Offset = 0;
1612         match(A, m_Add(m_Value(A), m_ConstantInt(Offset)));
1613         if (match(A, m_PtrToInt(m_Value(A)))) {
1614           /// Note: this doesn't preserve the offset information but merges
1615           /// offset and alignment.
1616           /// TODO: we can generate a GEP instead of merging the alignment with
1617           /// the offset.
1618           RetainedKnowledge RK{Attribute::Alignment,
1619                                (unsigned)MinAlign(Offset, AlignMask + 1), A};
1620           if (IntrinsicInst *Replacement =
1621                   buildAssumeFromKnowledge(RK, Next, &AC, &DT)) {
1622 
1623             Replacement->insertAfter(II);
1624             AC.registerAssumption(Replacement);
1625           }
1626           return RemoveConditionFromAssume(II);
1627         }
1628       }
1629     }
1630 
1631     /// Canonicalize Knowledge in operand bundles.
1632     if (EnableKnowledgeRetention && II->hasOperandBundles()) {
1633       for (unsigned Idx = 0; Idx < II->getNumOperandBundles(); Idx++) {
1634         auto &BOI = II->bundle_op_info_begin()[Idx];
1635         RetainedKnowledge RK = llvm::getKnowledgeFromBundle(*II, BOI);
1636         if (BOI.End - BOI.Begin > 2)
1637           continue; // Prevent reducing knowledge in an align with offset since
1638                     // extracting a RetainedKnowledge form them looses offset
1639                     // information
1640         RetainedKnowledge CanonRK = llvm::simplifyRetainedKnowledge(
1641             II, RK, &getAssumptionCache(), &getDominatorTree());
1642         if (CanonRK == RK)
1643           continue;
1644         if (!CanonRK) {
1645           if (BOI.End - BOI.Begin > 0) {
1646             Worklist.pushValue(II->op_begin()[BOI.Begin]);
1647             Value::dropDroppableUse(II->op_begin()[BOI.Begin]);
1648           }
1649           continue;
1650         }
1651         assert(RK.AttrKind == CanonRK.AttrKind);
1652         if (BOI.End - BOI.Begin > 0)
1653           II->op_begin()[BOI.Begin].set(CanonRK.WasOn);
1654         if (BOI.End - BOI.Begin > 1)
1655           II->op_begin()[BOI.Begin + 1].set(ConstantInt::get(
1656               Type::getInt64Ty(II->getContext()), CanonRK.ArgValue));
1657         if (RK.WasOn)
1658           Worklist.pushValue(RK.WasOn);
1659         return II;
1660       }
1661     }
1662 
1663     // If there is a dominating assume with the same condition as this one,
1664     // then this one is redundant, and should be removed.
1665     KnownBits Known(1);
1666     computeKnownBits(IIOperand, Known, 0, II);
1667     if (Known.isAllOnes() && isAssumeWithEmptyBundle(*II))
1668       return eraseInstFromFunction(*II);
1669 
1670     // Update the cache of affected values for this assumption (we might be
1671     // here because we just simplified the condition).
1672     AC.updateAffectedValues(II);
1673     break;
1674   }
1675   case Intrinsic::experimental_guard: {
1676     // Is this guard followed by another guard?  We scan forward over a small
1677     // fixed window of instructions to handle common cases with conditions
1678     // computed between guards.
1679     Instruction *NextInst = II->getNextNonDebugInstruction();
1680     for (unsigned i = 0; i < GuardWideningWindow; i++) {
1681       // Note: Using context-free form to avoid compile time blow up
1682       if (!isSafeToSpeculativelyExecute(NextInst))
1683         break;
1684       NextInst = NextInst->getNextNonDebugInstruction();
1685     }
1686     Value *NextCond = nullptr;
1687     if (match(NextInst,
1688               m_Intrinsic<Intrinsic::experimental_guard>(m_Value(NextCond)))) {
1689       Value *CurrCond = II->getArgOperand(0);
1690 
1691       // Remove a guard that it is immediately preceded by an identical guard.
1692       // Otherwise canonicalize guard(a); guard(b) -> guard(a & b).
1693       if (CurrCond != NextCond) {
1694         Instruction *MoveI = II->getNextNonDebugInstruction();
1695         while (MoveI != NextInst) {
1696           auto *Temp = MoveI;
1697           MoveI = MoveI->getNextNonDebugInstruction();
1698           Temp->moveBefore(II);
1699         }
1700         replaceOperand(*II, 0, Builder.CreateAnd(CurrCond, NextCond));
1701       }
1702       eraseInstFromFunction(*NextInst);
1703       return II;
1704     }
1705     break;
1706   }
1707   case Intrinsic::experimental_vector_insert: {
1708     Value *Vec = II->getArgOperand(0);
1709     Value *SubVec = II->getArgOperand(1);
1710     Value *Idx = II->getArgOperand(2);
1711     auto *DstTy = dyn_cast<FixedVectorType>(II->getType());
1712     auto *VecTy = dyn_cast<FixedVectorType>(Vec->getType());
1713     auto *SubVecTy = dyn_cast<FixedVectorType>(SubVec->getType());
1714 
1715     // Only canonicalize if the destination vector, Vec, and SubVec are all
1716     // fixed vectors.
1717     if (DstTy && VecTy && SubVecTy) {
1718       unsigned DstNumElts = DstTy->getNumElements();
1719       unsigned VecNumElts = VecTy->getNumElements();
1720       unsigned SubVecNumElts = SubVecTy->getNumElements();
1721       unsigned IdxN = cast<ConstantInt>(Idx)->getZExtValue();
1722 
1723       // The result of this call is undefined if IdxN is not a constant multiple
1724       // of the SubVec's minimum vector length OR the insertion overruns Vec.
1725       if (IdxN % SubVecNumElts != 0 || IdxN + SubVecNumElts > VecNumElts) {
1726         replaceInstUsesWith(CI, UndefValue::get(CI.getType()));
1727         return eraseInstFromFunction(CI);
1728       }
1729 
1730       // An insert that entirely overwrites Vec with SubVec is a nop.
1731       if (VecNumElts == SubVecNumElts) {
1732         replaceInstUsesWith(CI, SubVec);
1733         return eraseInstFromFunction(CI);
1734       }
1735 
1736       // Widen SubVec into a vector of the same width as Vec, since
1737       // shufflevector requires the two input vectors to be the same width.
1738       // Elements beyond the bounds of SubVec within the widened vector are
1739       // undefined.
1740       SmallVector<int, 8> WidenMask;
1741       unsigned i;
1742       for (i = 0; i != SubVecNumElts; ++i)
1743         WidenMask.push_back(i);
1744       for (; i != VecNumElts; ++i)
1745         WidenMask.push_back(UndefMaskElem);
1746 
1747       Value *WidenShuffle = Builder.CreateShuffleVector(SubVec, WidenMask);
1748 
1749       SmallVector<int, 8> Mask;
1750       for (unsigned i = 0; i != IdxN; ++i)
1751         Mask.push_back(i);
1752       for (unsigned i = DstNumElts; i != DstNumElts + SubVecNumElts; ++i)
1753         Mask.push_back(i);
1754       for (unsigned i = IdxN + SubVecNumElts; i != DstNumElts; ++i)
1755         Mask.push_back(i);
1756 
1757       Value *Shuffle = Builder.CreateShuffleVector(Vec, WidenShuffle, Mask);
1758       replaceInstUsesWith(CI, Shuffle);
1759       return eraseInstFromFunction(CI);
1760     }
1761     break;
1762   }
1763   case Intrinsic::experimental_vector_extract: {
1764     Value *Vec = II->getArgOperand(0);
1765     Value *Idx = II->getArgOperand(1);
1766 
1767     auto *DstTy = dyn_cast<FixedVectorType>(II->getType());
1768     auto *VecTy = dyn_cast<FixedVectorType>(Vec->getType());
1769 
1770     // Only canonicalize if the the destination vector and Vec are fixed
1771     // vectors.
1772     if (DstTy && VecTy) {
1773       unsigned DstNumElts = DstTy->getNumElements();
1774       unsigned VecNumElts = VecTy->getNumElements();
1775       unsigned IdxN = cast<ConstantInt>(Idx)->getZExtValue();
1776 
1777       // The result of this call is undefined if IdxN is not a constant multiple
1778       // of the result type's minimum vector length OR the extraction overruns
1779       // Vec.
1780       if (IdxN % DstNumElts != 0 || IdxN + DstNumElts > VecNumElts) {
1781         replaceInstUsesWith(CI, UndefValue::get(CI.getType()));
1782         return eraseInstFromFunction(CI);
1783       }
1784 
1785       // Extracting the entirety of Vec is a nop.
1786       if (VecNumElts == DstNumElts) {
1787         replaceInstUsesWith(CI, Vec);
1788         return eraseInstFromFunction(CI);
1789       }
1790 
1791       SmallVector<int, 8> Mask;
1792       for (unsigned i = 0; i != DstNumElts; ++i)
1793         Mask.push_back(IdxN + i);
1794 
1795       Value *Shuffle =
1796           Builder.CreateShuffleVector(Vec, UndefValue::get(VecTy), Mask);
1797       replaceInstUsesWith(CI, Shuffle);
1798       return eraseInstFromFunction(CI);
1799     }
1800     break;
1801   }
1802   case Intrinsic::vector_reduce_or:
1803   case Intrinsic::vector_reduce_and: {
1804     // Canonicalize logical or/and reductions:
1805     // Or reduction for i1 is represented as:
1806     // %val = bitcast <ReduxWidth x i1> to iReduxWidth
1807     // %res = cmp ne iReduxWidth %val, 0
1808     // And reduction for i1 is represented as:
1809     // %val = bitcast <ReduxWidth x i1> to iReduxWidth
1810     // %res = cmp eq iReduxWidth %val, 11111
1811     Value *Arg = II->getArgOperand(0);
1812     Type *RetTy = II->getType();
1813     if (RetTy == Builder.getInt1Ty())
1814       if (auto *FVTy = dyn_cast<FixedVectorType>(Arg->getType())) {
1815         Value *Res = Builder.CreateBitCast(
1816             Arg, Builder.getIntNTy(FVTy->getNumElements()));
1817         if (IID == Intrinsic::vector_reduce_and) {
1818           Res = Builder.CreateICmpEQ(
1819               Res, ConstantInt::getAllOnesValue(Res->getType()));
1820         } else {
1821           assert(IID == Intrinsic::vector_reduce_or &&
1822                  "Expected or reduction.");
1823           Res = Builder.CreateIsNotNull(Res);
1824         }
1825         replaceInstUsesWith(CI, Res);
1826         return eraseInstFromFunction(CI);
1827       }
1828     break;
1829   }
1830   default: {
1831     // Handle target specific intrinsics
1832     Optional<Instruction *> V = targetInstCombineIntrinsic(*II);
1833     if (V.hasValue())
1834       return V.getValue();
1835     break;
1836   }
1837   }
1838   // Some intrinsics (like experimental_gc_statepoint) can be used in invoke
1839   // context, so it is handled in visitCallBase and we should trigger it.
1840   return visitCallBase(*II);
1841 }
1842 
1843 // Fence instruction simplification
1844 Instruction *InstCombinerImpl::visitFenceInst(FenceInst &FI) {
1845   // Remove identical consecutive fences.
1846   Instruction *Next = FI.getNextNonDebugInstruction();
1847   if (auto *NFI = dyn_cast<FenceInst>(Next))
1848     if (FI.isIdenticalTo(NFI))
1849       return eraseInstFromFunction(FI);
1850   return nullptr;
1851 }
1852 
1853 // InvokeInst simplification
1854 Instruction *InstCombinerImpl::visitInvokeInst(InvokeInst &II) {
1855   return visitCallBase(II);
1856 }
1857 
1858 // CallBrInst simplification
1859 Instruction *InstCombinerImpl::visitCallBrInst(CallBrInst &CBI) {
1860   return visitCallBase(CBI);
1861 }
1862 
1863 /// If this cast does not affect the value passed through the varargs area, we
1864 /// can eliminate the use of the cast.
1865 static bool isSafeToEliminateVarargsCast(const CallBase &Call,
1866                                          const DataLayout &DL,
1867                                          const CastInst *const CI,
1868                                          const int ix) {
1869   if (!CI->isLosslessCast())
1870     return false;
1871 
1872   // If this is a GC intrinsic, avoid munging types.  We need types for
1873   // statepoint reconstruction in SelectionDAG.
1874   // TODO: This is probably something which should be expanded to all
1875   // intrinsics since the entire point of intrinsics is that
1876   // they are understandable by the optimizer.
1877   if (isa<GCStatepointInst>(Call) || isa<GCRelocateInst>(Call) ||
1878       isa<GCResultInst>(Call))
1879     return false;
1880 
1881   // The size of ByVal or InAlloca arguments is derived from the type, so we
1882   // can't change to a type with a different size.  If the size were
1883   // passed explicitly we could avoid this check.
1884   if (!Call.isPassPointeeByValueArgument(ix))
1885     return true;
1886 
1887   Type* SrcTy =
1888             cast<PointerType>(CI->getOperand(0)->getType())->getElementType();
1889   Type *DstTy = Call.isByValArgument(ix)
1890                     ? Call.getParamByValType(ix)
1891                     : cast<PointerType>(CI->getType())->getElementType();
1892   if (!SrcTy->isSized() || !DstTy->isSized())
1893     return false;
1894   if (DL.getTypeAllocSize(SrcTy) != DL.getTypeAllocSize(DstTy))
1895     return false;
1896   return true;
1897 }
1898 
1899 Instruction *InstCombinerImpl::tryOptimizeCall(CallInst *CI) {
1900   if (!CI->getCalledFunction()) return nullptr;
1901 
1902   auto InstCombineRAUW = [this](Instruction *From, Value *With) {
1903     replaceInstUsesWith(*From, With);
1904   };
1905   auto InstCombineErase = [this](Instruction *I) {
1906     eraseInstFromFunction(*I);
1907   };
1908   LibCallSimplifier Simplifier(DL, &TLI, ORE, BFI, PSI, InstCombineRAUW,
1909                                InstCombineErase);
1910   if (Value *With = Simplifier.optimizeCall(CI, Builder)) {
1911     ++NumSimplified;
1912     return CI->use_empty() ? CI : replaceInstUsesWith(*CI, With);
1913   }
1914 
1915   return nullptr;
1916 }
1917 
1918 static IntrinsicInst *findInitTrampolineFromAlloca(Value *TrampMem) {
1919   // Strip off at most one level of pointer casts, looking for an alloca.  This
1920   // is good enough in practice and simpler than handling any number of casts.
1921   Value *Underlying = TrampMem->stripPointerCasts();
1922   if (Underlying != TrampMem &&
1923       (!Underlying->hasOneUse() || Underlying->user_back() != TrampMem))
1924     return nullptr;
1925   if (!isa<AllocaInst>(Underlying))
1926     return nullptr;
1927 
1928   IntrinsicInst *InitTrampoline = nullptr;
1929   for (User *U : TrampMem->users()) {
1930     IntrinsicInst *II = dyn_cast<IntrinsicInst>(U);
1931     if (!II)
1932       return nullptr;
1933     if (II->getIntrinsicID() == Intrinsic::init_trampoline) {
1934       if (InitTrampoline)
1935         // More than one init_trampoline writes to this value.  Give up.
1936         return nullptr;
1937       InitTrampoline = II;
1938       continue;
1939     }
1940     if (II->getIntrinsicID() == Intrinsic::adjust_trampoline)
1941       // Allow any number of calls to adjust.trampoline.
1942       continue;
1943     return nullptr;
1944   }
1945 
1946   // No call to init.trampoline found.
1947   if (!InitTrampoline)
1948     return nullptr;
1949 
1950   // Check that the alloca is being used in the expected way.
1951   if (InitTrampoline->getOperand(0) != TrampMem)
1952     return nullptr;
1953 
1954   return InitTrampoline;
1955 }
1956 
1957 static IntrinsicInst *findInitTrampolineFromBB(IntrinsicInst *AdjustTramp,
1958                                                Value *TrampMem) {
1959   // Visit all the previous instructions in the basic block, and try to find a
1960   // init.trampoline which has a direct path to the adjust.trampoline.
1961   for (BasicBlock::iterator I = AdjustTramp->getIterator(),
1962                             E = AdjustTramp->getParent()->begin();
1963        I != E;) {
1964     Instruction *Inst = &*--I;
1965     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I))
1966       if (II->getIntrinsicID() == Intrinsic::init_trampoline &&
1967           II->getOperand(0) == TrampMem)
1968         return II;
1969     if (Inst->mayWriteToMemory())
1970       return nullptr;
1971   }
1972   return nullptr;
1973 }
1974 
1975 // Given a call to llvm.adjust.trampoline, find and return the corresponding
1976 // call to llvm.init.trampoline if the call to the trampoline can be optimized
1977 // to a direct call to a function.  Otherwise return NULL.
1978 static IntrinsicInst *findInitTrampoline(Value *Callee) {
1979   Callee = Callee->stripPointerCasts();
1980   IntrinsicInst *AdjustTramp = dyn_cast<IntrinsicInst>(Callee);
1981   if (!AdjustTramp ||
1982       AdjustTramp->getIntrinsicID() != Intrinsic::adjust_trampoline)
1983     return nullptr;
1984 
1985   Value *TrampMem = AdjustTramp->getOperand(0);
1986 
1987   if (IntrinsicInst *IT = findInitTrampolineFromAlloca(TrampMem))
1988     return IT;
1989   if (IntrinsicInst *IT = findInitTrampolineFromBB(AdjustTramp, TrampMem))
1990     return IT;
1991   return nullptr;
1992 }
1993 
1994 static void annotateAnyAllocSite(CallBase &Call, const TargetLibraryInfo *TLI) {
1995   unsigned NumArgs = Call.getNumArgOperands();
1996   ConstantInt *Op0C = dyn_cast<ConstantInt>(Call.getOperand(0));
1997   ConstantInt *Op1C =
1998       (NumArgs == 1) ? nullptr : dyn_cast<ConstantInt>(Call.getOperand(1));
1999   // Bail out if the allocation size is zero (or an invalid alignment of zero
2000   // with aligned_alloc).
2001   if ((Op0C && Op0C->isNullValue()) || (Op1C && Op1C->isNullValue()))
2002     return;
2003 
2004   if (isMallocLikeFn(&Call, TLI) && Op0C) {
2005     if (isOpNewLikeFn(&Call, TLI))
2006       Call.addAttribute(AttributeList::ReturnIndex,
2007                         Attribute::getWithDereferenceableBytes(
2008                             Call.getContext(), Op0C->getZExtValue()));
2009     else
2010       Call.addAttribute(AttributeList::ReturnIndex,
2011                         Attribute::getWithDereferenceableOrNullBytes(
2012                             Call.getContext(), Op0C->getZExtValue()));
2013   } else if (isAlignedAllocLikeFn(&Call, TLI) && Op1C) {
2014     Call.addAttribute(AttributeList::ReturnIndex,
2015                       Attribute::getWithDereferenceableOrNullBytes(
2016                           Call.getContext(), Op1C->getZExtValue()));
2017     // Add alignment attribute if alignment is a power of two constant.
2018     if (Op0C && Op0C->getValue().ult(llvm::Value::MaximumAlignment)) {
2019       uint64_t AlignmentVal = Op0C->getZExtValue();
2020       if (llvm::isPowerOf2_64(AlignmentVal))
2021         Call.addAttribute(AttributeList::ReturnIndex,
2022                           Attribute::getWithAlignment(Call.getContext(),
2023                                                       Align(AlignmentVal)));
2024     }
2025   } else if (isReallocLikeFn(&Call, TLI) && Op1C) {
2026     Call.addAttribute(AttributeList::ReturnIndex,
2027                       Attribute::getWithDereferenceableOrNullBytes(
2028                           Call.getContext(), Op1C->getZExtValue()));
2029   } else if (isCallocLikeFn(&Call, TLI) && Op0C && Op1C) {
2030     bool Overflow;
2031     const APInt &N = Op0C->getValue();
2032     APInt Size = N.umul_ov(Op1C->getValue(), Overflow);
2033     if (!Overflow)
2034       Call.addAttribute(AttributeList::ReturnIndex,
2035                         Attribute::getWithDereferenceableOrNullBytes(
2036                             Call.getContext(), Size.getZExtValue()));
2037   } else if (isStrdupLikeFn(&Call, TLI)) {
2038     uint64_t Len = GetStringLength(Call.getOperand(0));
2039     if (Len) {
2040       // strdup
2041       if (NumArgs == 1)
2042         Call.addAttribute(AttributeList::ReturnIndex,
2043                           Attribute::getWithDereferenceableOrNullBytes(
2044                               Call.getContext(), Len));
2045       // strndup
2046       else if (NumArgs == 2 && Op1C)
2047         Call.addAttribute(
2048             AttributeList::ReturnIndex,
2049             Attribute::getWithDereferenceableOrNullBytes(
2050                 Call.getContext(), std::min(Len, Op1C->getZExtValue() + 1)));
2051     }
2052   }
2053 }
2054 
2055 /// Improvements for call, callbr and invoke instructions.
2056 Instruction *InstCombinerImpl::visitCallBase(CallBase &Call) {
2057   if (isAllocationFn(&Call, &TLI))
2058     annotateAnyAllocSite(Call, &TLI);
2059 
2060   bool Changed = false;
2061 
2062   // Mark any parameters that are known to be non-null with the nonnull
2063   // attribute.  This is helpful for inlining calls to functions with null
2064   // checks on their arguments.
2065   SmallVector<unsigned, 4> ArgNos;
2066   unsigned ArgNo = 0;
2067 
2068   for (Value *V : Call.args()) {
2069     if (V->getType()->isPointerTy() &&
2070         !Call.paramHasAttr(ArgNo, Attribute::NonNull) &&
2071         isKnownNonZero(V, DL, 0, &AC, &Call, &DT))
2072       ArgNos.push_back(ArgNo);
2073     ArgNo++;
2074   }
2075 
2076   assert(ArgNo == Call.arg_size() && "sanity check");
2077 
2078   if (!ArgNos.empty()) {
2079     AttributeList AS = Call.getAttributes();
2080     LLVMContext &Ctx = Call.getContext();
2081     AS = AS.addParamAttribute(Ctx, ArgNos,
2082                               Attribute::get(Ctx, Attribute::NonNull));
2083     Call.setAttributes(AS);
2084     Changed = true;
2085   }
2086 
2087   // If the callee is a pointer to a function, attempt to move any casts to the
2088   // arguments of the call/callbr/invoke.
2089   Value *Callee = Call.getCalledOperand();
2090   if (!isa<Function>(Callee) && transformConstExprCastCall(Call))
2091     return nullptr;
2092 
2093   if (Function *CalleeF = dyn_cast<Function>(Callee)) {
2094     // Remove the convergent attr on calls when the callee is not convergent.
2095     if (Call.isConvergent() && !CalleeF->isConvergent() &&
2096         !CalleeF->isIntrinsic()) {
2097       LLVM_DEBUG(dbgs() << "Removing convergent attr from instr " << Call
2098                         << "\n");
2099       Call.setNotConvergent();
2100       return &Call;
2101     }
2102 
2103     // If the call and callee calling conventions don't match, this call must
2104     // be unreachable, as the call is undefined.
2105     if (CalleeF->getCallingConv() != Call.getCallingConv() &&
2106         // Only do this for calls to a function with a body.  A prototype may
2107         // not actually end up matching the implementation's calling conv for a
2108         // variety of reasons (e.g. it may be written in assembly).
2109         !CalleeF->isDeclaration()) {
2110       Instruction *OldCall = &Call;
2111       CreateNonTerminatorUnreachable(OldCall);
2112       // If OldCall does not return void then replaceInstUsesWith undef.
2113       // This allows ValueHandlers and custom metadata to adjust itself.
2114       if (!OldCall->getType()->isVoidTy())
2115         replaceInstUsesWith(*OldCall, UndefValue::get(OldCall->getType()));
2116       if (isa<CallInst>(OldCall))
2117         return eraseInstFromFunction(*OldCall);
2118 
2119       // We cannot remove an invoke or a callbr, because it would change thexi
2120       // CFG, just change the callee to a null pointer.
2121       cast<CallBase>(OldCall)->setCalledFunction(
2122           CalleeF->getFunctionType(),
2123           Constant::getNullValue(CalleeF->getType()));
2124       return nullptr;
2125     }
2126   }
2127 
2128   if ((isa<ConstantPointerNull>(Callee) &&
2129        !NullPointerIsDefined(Call.getFunction())) ||
2130       isa<UndefValue>(Callee)) {
2131     // If Call does not return void then replaceInstUsesWith undef.
2132     // This allows ValueHandlers and custom metadata to adjust itself.
2133     if (!Call.getType()->isVoidTy())
2134       replaceInstUsesWith(Call, UndefValue::get(Call.getType()));
2135 
2136     if (Call.isTerminator()) {
2137       // Can't remove an invoke or callbr because we cannot change the CFG.
2138       return nullptr;
2139     }
2140 
2141     // This instruction is not reachable, just remove it.
2142     CreateNonTerminatorUnreachable(&Call);
2143     return eraseInstFromFunction(Call);
2144   }
2145 
2146   if (IntrinsicInst *II = findInitTrampoline(Callee))
2147     return transformCallThroughTrampoline(Call, *II);
2148 
2149   PointerType *PTy = cast<PointerType>(Callee->getType());
2150   FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2151   if (FTy->isVarArg()) {
2152     int ix = FTy->getNumParams();
2153     // See if we can optimize any arguments passed through the varargs area of
2154     // the call.
2155     for (auto I = Call.arg_begin() + FTy->getNumParams(), E = Call.arg_end();
2156          I != E; ++I, ++ix) {
2157       CastInst *CI = dyn_cast<CastInst>(*I);
2158       if (CI && isSafeToEliminateVarargsCast(Call, DL, CI, ix)) {
2159         replaceUse(*I, CI->getOperand(0));
2160 
2161         // Update the byval type to match the argument type.
2162         if (Call.isByValArgument(ix)) {
2163           Call.removeParamAttr(ix, Attribute::ByVal);
2164           Call.addParamAttr(
2165               ix, Attribute::getWithByValType(
2166                       Call.getContext(),
2167                       CI->getOperand(0)->getType()->getPointerElementType()));
2168         }
2169         Changed = true;
2170       }
2171     }
2172   }
2173 
2174   if (isa<InlineAsm>(Callee) && !Call.doesNotThrow()) {
2175     // Inline asm calls cannot throw - mark them 'nounwind'.
2176     Call.setDoesNotThrow();
2177     Changed = true;
2178   }
2179 
2180   // Try to optimize the call if possible, we require DataLayout for most of
2181   // this.  None of these calls are seen as possibly dead so go ahead and
2182   // delete the instruction now.
2183   if (CallInst *CI = dyn_cast<CallInst>(&Call)) {
2184     Instruction *I = tryOptimizeCall(CI);
2185     // If we changed something return the result, etc. Otherwise let
2186     // the fallthrough check.
2187     if (I) return eraseInstFromFunction(*I);
2188   }
2189 
2190   if (!Call.use_empty() && !Call.isMustTailCall())
2191     if (Value *ReturnedArg = Call.getReturnedArgOperand()) {
2192       Type *CallTy = Call.getType();
2193       Type *RetArgTy = ReturnedArg->getType();
2194       if (RetArgTy->canLosslesslyBitCastTo(CallTy))
2195         return replaceInstUsesWith(
2196             Call, Builder.CreateBitOrPointerCast(ReturnedArg, CallTy));
2197     }
2198 
2199   if (isAllocLikeFn(&Call, &TLI))
2200     return visitAllocSite(Call);
2201 
2202   // Handle intrinsics which can be used in both call and invoke context.
2203   switch (Call.getIntrinsicID()) {
2204   case Intrinsic::experimental_gc_statepoint: {
2205     GCStatepointInst &GCSP = *cast<GCStatepointInst>(&Call);
2206     SmallPtrSet<Value *, 32> LiveGcValues;
2207     for (const GCRelocateInst *Reloc : GCSP.getGCRelocates()) {
2208       GCRelocateInst &GCR = *const_cast<GCRelocateInst *>(Reloc);
2209 
2210       // Remove the relocation if unused.
2211       if (GCR.use_empty()) {
2212         eraseInstFromFunction(GCR);
2213         continue;
2214       }
2215 
2216       Value *DerivedPtr = GCR.getDerivedPtr();
2217       Value *BasePtr = GCR.getBasePtr();
2218 
2219       // Undef is undef, even after relocation.
2220       if (isa<UndefValue>(DerivedPtr) || isa<UndefValue>(BasePtr)) {
2221         replaceInstUsesWith(GCR, UndefValue::get(GCR.getType()));
2222         eraseInstFromFunction(GCR);
2223         continue;
2224       }
2225 
2226       if (auto *PT = dyn_cast<PointerType>(GCR.getType())) {
2227         // The relocation of null will be null for most any collector.
2228         // TODO: provide a hook for this in GCStrategy.  There might be some
2229         // weird collector this property does not hold for.
2230         if (isa<ConstantPointerNull>(DerivedPtr)) {
2231           // Use null-pointer of gc_relocate's type to replace it.
2232           replaceInstUsesWith(GCR, ConstantPointerNull::get(PT));
2233           eraseInstFromFunction(GCR);
2234           continue;
2235         }
2236 
2237         // isKnownNonNull -> nonnull attribute
2238         if (!GCR.hasRetAttr(Attribute::NonNull) &&
2239             isKnownNonZero(DerivedPtr, DL, 0, &AC, &Call, &DT)) {
2240           GCR.addAttribute(AttributeList::ReturnIndex, Attribute::NonNull);
2241           // We discovered new fact, re-check users.
2242           Worklist.pushUsersToWorkList(GCR);
2243         }
2244       }
2245 
2246       // If we have two copies of the same pointer in the statepoint argument
2247       // list, canonicalize to one.  This may let us common gc.relocates.
2248       if (GCR.getBasePtr() == GCR.getDerivedPtr() &&
2249           GCR.getBasePtrIndex() != GCR.getDerivedPtrIndex()) {
2250         auto *OpIntTy = GCR.getOperand(2)->getType();
2251         GCR.setOperand(2, ConstantInt::get(OpIntTy, GCR.getBasePtrIndex()));
2252       }
2253 
2254       // TODO: bitcast(relocate(p)) -> relocate(bitcast(p))
2255       // Canonicalize on the type from the uses to the defs
2256 
2257       // TODO: relocate((gep p, C, C2, ...)) -> gep(relocate(p), C, C2, ...)
2258       LiveGcValues.insert(BasePtr);
2259       LiveGcValues.insert(DerivedPtr);
2260     }
2261     Optional<OperandBundleUse> Bundle =
2262         GCSP.getOperandBundle(LLVMContext::OB_gc_live);
2263     unsigned NumOfGCLives = LiveGcValues.size();
2264     if (!Bundle.hasValue() || NumOfGCLives == Bundle->Inputs.size())
2265       break;
2266     // We can reduce the size of gc live bundle.
2267     DenseMap<Value *, unsigned> Val2Idx;
2268     std::vector<Value *> NewLiveGc;
2269     for (unsigned I = 0, E = Bundle->Inputs.size(); I < E; ++I) {
2270       Value *V = Bundle->Inputs[I];
2271       if (Val2Idx.count(V))
2272         continue;
2273       if (LiveGcValues.count(V)) {
2274         Val2Idx[V] = NewLiveGc.size();
2275         NewLiveGc.push_back(V);
2276       } else
2277         Val2Idx[V] = NumOfGCLives;
2278     }
2279     // Update all gc.relocates
2280     for (const GCRelocateInst *Reloc : GCSP.getGCRelocates()) {
2281       GCRelocateInst &GCR = *const_cast<GCRelocateInst *>(Reloc);
2282       Value *BasePtr = GCR.getBasePtr();
2283       assert(Val2Idx.count(BasePtr) && Val2Idx[BasePtr] != NumOfGCLives &&
2284              "Missed live gc for base pointer");
2285       auto *OpIntTy1 = GCR.getOperand(1)->getType();
2286       GCR.setOperand(1, ConstantInt::get(OpIntTy1, Val2Idx[BasePtr]));
2287       Value *DerivedPtr = GCR.getDerivedPtr();
2288       assert(Val2Idx.count(DerivedPtr) && Val2Idx[DerivedPtr] != NumOfGCLives &&
2289              "Missed live gc for derived pointer");
2290       auto *OpIntTy2 = GCR.getOperand(2)->getType();
2291       GCR.setOperand(2, ConstantInt::get(OpIntTy2, Val2Idx[DerivedPtr]));
2292     }
2293     // Create new statepoint instruction.
2294     OperandBundleDef NewBundle("gc-live", NewLiveGc);
2295     return CallBase::Create(&Call, NewBundle);
2296   }
2297   default: { break; }
2298   }
2299 
2300   return Changed ? &Call : nullptr;
2301 }
2302 
2303 /// If the callee is a constexpr cast of a function, attempt to move the cast to
2304 /// the arguments of the call/callbr/invoke.
2305 bool InstCombinerImpl::transformConstExprCastCall(CallBase &Call) {
2306   auto *Callee =
2307       dyn_cast<Function>(Call.getCalledOperand()->stripPointerCasts());
2308   if (!Callee)
2309     return false;
2310 
2311   // If this is a call to a thunk function, don't remove the cast. Thunks are
2312   // used to transparently forward all incoming parameters and outgoing return
2313   // values, so it's important to leave the cast in place.
2314   if (Callee->hasFnAttribute("thunk"))
2315     return false;
2316 
2317   // If this is a musttail call, the callee's prototype must match the caller's
2318   // prototype with the exception of pointee types. The code below doesn't
2319   // implement that, so we can't do this transform.
2320   // TODO: Do the transform if it only requires adding pointer casts.
2321   if (Call.isMustTailCall())
2322     return false;
2323 
2324   Instruction *Caller = &Call;
2325   const AttributeList &CallerPAL = Call.getAttributes();
2326 
2327   // Okay, this is a cast from a function to a different type.  Unless doing so
2328   // would cause a type conversion of one of our arguments, change this call to
2329   // be a direct call with arguments casted to the appropriate types.
2330   FunctionType *FT = Callee->getFunctionType();
2331   Type *OldRetTy = Caller->getType();
2332   Type *NewRetTy = FT->getReturnType();
2333 
2334   // Check to see if we are changing the return type...
2335   if (OldRetTy != NewRetTy) {
2336 
2337     if (NewRetTy->isStructTy())
2338       return false; // TODO: Handle multiple return values.
2339 
2340     if (!CastInst::isBitOrNoopPointerCastable(NewRetTy, OldRetTy, DL)) {
2341       if (Callee->isDeclaration())
2342         return false;   // Cannot transform this return value.
2343 
2344       if (!Caller->use_empty() &&
2345           // void -> non-void is handled specially
2346           !NewRetTy->isVoidTy())
2347         return false;   // Cannot transform this return value.
2348     }
2349 
2350     if (!CallerPAL.isEmpty() && !Caller->use_empty()) {
2351       AttrBuilder RAttrs(CallerPAL, AttributeList::ReturnIndex);
2352       if (RAttrs.overlaps(AttributeFuncs::typeIncompatible(NewRetTy)))
2353         return false;   // Attribute not compatible with transformed value.
2354     }
2355 
2356     // If the callbase is an invoke/callbr instruction, and the return value is
2357     // used by a PHI node in a successor, we cannot change the return type of
2358     // the call because there is no place to put the cast instruction (without
2359     // breaking the critical edge).  Bail out in this case.
2360     if (!Caller->use_empty()) {
2361       if (InvokeInst *II = dyn_cast<InvokeInst>(Caller))
2362         for (User *U : II->users())
2363           if (PHINode *PN = dyn_cast<PHINode>(U))
2364             if (PN->getParent() == II->getNormalDest() ||
2365                 PN->getParent() == II->getUnwindDest())
2366               return false;
2367       // FIXME: Be conservative for callbr to avoid a quadratic search.
2368       if (isa<CallBrInst>(Caller))
2369         return false;
2370     }
2371   }
2372 
2373   unsigned NumActualArgs = Call.arg_size();
2374   unsigned NumCommonArgs = std::min(FT->getNumParams(), NumActualArgs);
2375 
2376   // Prevent us turning:
2377   // declare void @takes_i32_inalloca(i32* inalloca)
2378   //  call void bitcast (void (i32*)* @takes_i32_inalloca to void (i32)*)(i32 0)
2379   //
2380   // into:
2381   //  call void @takes_i32_inalloca(i32* null)
2382   //
2383   //  Similarly, avoid folding away bitcasts of byval calls.
2384   if (Callee->getAttributes().hasAttrSomewhere(Attribute::InAlloca) ||
2385       Callee->getAttributes().hasAttrSomewhere(Attribute::Preallocated) ||
2386       Callee->getAttributes().hasAttrSomewhere(Attribute::ByVal))
2387     return false;
2388 
2389   auto AI = Call.arg_begin();
2390   for (unsigned i = 0, e = NumCommonArgs; i != e; ++i, ++AI) {
2391     Type *ParamTy = FT->getParamType(i);
2392     Type *ActTy = (*AI)->getType();
2393 
2394     if (!CastInst::isBitOrNoopPointerCastable(ActTy, ParamTy, DL))
2395       return false;   // Cannot transform this parameter value.
2396 
2397     if (AttrBuilder(CallerPAL.getParamAttributes(i))
2398             .overlaps(AttributeFuncs::typeIncompatible(ParamTy)))
2399       return false;   // Attribute not compatible with transformed value.
2400 
2401     if (Call.isInAllocaArgument(i))
2402       return false;   // Cannot transform to and from inalloca.
2403 
2404     if (CallerPAL.hasParamAttribute(i, Attribute::SwiftError))
2405       return false;
2406 
2407     // If the parameter is passed as a byval argument, then we have to have a
2408     // sized type and the sized type has to have the same size as the old type.
2409     if (ParamTy != ActTy && CallerPAL.hasParamAttribute(i, Attribute::ByVal)) {
2410       PointerType *ParamPTy = dyn_cast<PointerType>(ParamTy);
2411       if (!ParamPTy || !ParamPTy->getElementType()->isSized())
2412         return false;
2413 
2414       Type *CurElTy = Call.getParamByValType(i);
2415       if (DL.getTypeAllocSize(CurElTy) !=
2416           DL.getTypeAllocSize(ParamPTy->getElementType()))
2417         return false;
2418     }
2419   }
2420 
2421   if (Callee->isDeclaration()) {
2422     // Do not delete arguments unless we have a function body.
2423     if (FT->getNumParams() < NumActualArgs && !FT->isVarArg())
2424       return false;
2425 
2426     // If the callee is just a declaration, don't change the varargsness of the
2427     // call.  We don't want to introduce a varargs call where one doesn't
2428     // already exist.
2429     PointerType *APTy = cast<PointerType>(Call.getCalledOperand()->getType());
2430     if (FT->isVarArg()!=cast<FunctionType>(APTy->getElementType())->isVarArg())
2431       return false;
2432 
2433     // If both the callee and the cast type are varargs, we still have to make
2434     // sure the number of fixed parameters are the same or we have the same
2435     // ABI issues as if we introduce a varargs call.
2436     if (FT->isVarArg() &&
2437         cast<FunctionType>(APTy->getElementType())->isVarArg() &&
2438         FT->getNumParams() !=
2439         cast<FunctionType>(APTy->getElementType())->getNumParams())
2440       return false;
2441   }
2442 
2443   if (FT->getNumParams() < NumActualArgs && FT->isVarArg() &&
2444       !CallerPAL.isEmpty()) {
2445     // In this case we have more arguments than the new function type, but we
2446     // won't be dropping them.  Check that these extra arguments have attributes
2447     // that are compatible with being a vararg call argument.
2448     unsigned SRetIdx;
2449     if (CallerPAL.hasAttrSomewhere(Attribute::StructRet, &SRetIdx) &&
2450         SRetIdx > FT->getNumParams())
2451       return false;
2452   }
2453 
2454   // Okay, we decided that this is a safe thing to do: go ahead and start
2455   // inserting cast instructions as necessary.
2456   SmallVector<Value *, 8> Args;
2457   SmallVector<AttributeSet, 8> ArgAttrs;
2458   Args.reserve(NumActualArgs);
2459   ArgAttrs.reserve(NumActualArgs);
2460 
2461   // Get any return attributes.
2462   AttrBuilder RAttrs(CallerPAL, AttributeList::ReturnIndex);
2463 
2464   // If the return value is not being used, the type may not be compatible
2465   // with the existing attributes.  Wipe out any problematic attributes.
2466   RAttrs.remove(AttributeFuncs::typeIncompatible(NewRetTy));
2467 
2468   LLVMContext &Ctx = Call.getContext();
2469   AI = Call.arg_begin();
2470   for (unsigned i = 0; i != NumCommonArgs; ++i, ++AI) {
2471     Type *ParamTy = FT->getParamType(i);
2472 
2473     Value *NewArg = *AI;
2474     if ((*AI)->getType() != ParamTy)
2475       NewArg = Builder.CreateBitOrPointerCast(*AI, ParamTy);
2476     Args.push_back(NewArg);
2477 
2478     // Add any parameter attributes.
2479     if (CallerPAL.hasParamAttribute(i, Attribute::ByVal)) {
2480       AttrBuilder AB(CallerPAL.getParamAttributes(i));
2481       AB.addByValAttr(NewArg->getType()->getPointerElementType());
2482       ArgAttrs.push_back(AttributeSet::get(Ctx, AB));
2483     } else
2484       ArgAttrs.push_back(CallerPAL.getParamAttributes(i));
2485   }
2486 
2487   // If the function takes more arguments than the call was taking, add them
2488   // now.
2489   for (unsigned i = NumCommonArgs; i != FT->getNumParams(); ++i) {
2490     Args.push_back(Constant::getNullValue(FT->getParamType(i)));
2491     ArgAttrs.push_back(AttributeSet());
2492   }
2493 
2494   // If we are removing arguments to the function, emit an obnoxious warning.
2495   if (FT->getNumParams() < NumActualArgs) {
2496     // TODO: if (!FT->isVarArg()) this call may be unreachable. PR14722
2497     if (FT->isVarArg()) {
2498       // Add all of the arguments in their promoted form to the arg list.
2499       for (unsigned i = FT->getNumParams(); i != NumActualArgs; ++i, ++AI) {
2500         Type *PTy = getPromotedType((*AI)->getType());
2501         Value *NewArg = *AI;
2502         if (PTy != (*AI)->getType()) {
2503           // Must promote to pass through va_arg area!
2504           Instruction::CastOps opcode =
2505             CastInst::getCastOpcode(*AI, false, PTy, false);
2506           NewArg = Builder.CreateCast(opcode, *AI, PTy);
2507         }
2508         Args.push_back(NewArg);
2509 
2510         // Add any parameter attributes.
2511         ArgAttrs.push_back(CallerPAL.getParamAttributes(i));
2512       }
2513     }
2514   }
2515 
2516   AttributeSet FnAttrs = CallerPAL.getFnAttributes();
2517 
2518   if (NewRetTy->isVoidTy())
2519     Caller->setName("");   // Void type should not have a name.
2520 
2521   assert((ArgAttrs.size() == FT->getNumParams() || FT->isVarArg()) &&
2522          "missing argument attributes");
2523   AttributeList NewCallerPAL = AttributeList::get(
2524       Ctx, FnAttrs, AttributeSet::get(Ctx, RAttrs), ArgAttrs);
2525 
2526   SmallVector<OperandBundleDef, 1> OpBundles;
2527   Call.getOperandBundlesAsDefs(OpBundles);
2528 
2529   CallBase *NewCall;
2530   if (InvokeInst *II = dyn_cast<InvokeInst>(Caller)) {
2531     NewCall = Builder.CreateInvoke(Callee, II->getNormalDest(),
2532                                    II->getUnwindDest(), Args, OpBundles);
2533   } else if (CallBrInst *CBI = dyn_cast<CallBrInst>(Caller)) {
2534     NewCall = Builder.CreateCallBr(Callee, CBI->getDefaultDest(),
2535                                    CBI->getIndirectDests(), Args, OpBundles);
2536   } else {
2537     NewCall = Builder.CreateCall(Callee, Args, OpBundles);
2538     cast<CallInst>(NewCall)->setTailCallKind(
2539         cast<CallInst>(Caller)->getTailCallKind());
2540   }
2541   NewCall->takeName(Caller);
2542   NewCall->setCallingConv(Call.getCallingConv());
2543   NewCall->setAttributes(NewCallerPAL);
2544 
2545   // Preserve prof metadata if any.
2546   NewCall->copyMetadata(*Caller, {LLVMContext::MD_prof});
2547 
2548   // Insert a cast of the return type as necessary.
2549   Instruction *NC = NewCall;
2550   Value *NV = NC;
2551   if (OldRetTy != NV->getType() && !Caller->use_empty()) {
2552     if (!NV->getType()->isVoidTy()) {
2553       NV = NC = CastInst::CreateBitOrPointerCast(NC, OldRetTy);
2554       NC->setDebugLoc(Caller->getDebugLoc());
2555 
2556       // If this is an invoke/callbr instruction, we should insert it after the
2557       // first non-phi instruction in the normal successor block.
2558       if (InvokeInst *II = dyn_cast<InvokeInst>(Caller)) {
2559         BasicBlock::iterator I = II->getNormalDest()->getFirstInsertionPt();
2560         InsertNewInstBefore(NC, *I);
2561       } else if (CallBrInst *CBI = dyn_cast<CallBrInst>(Caller)) {
2562         BasicBlock::iterator I = CBI->getDefaultDest()->getFirstInsertionPt();
2563         InsertNewInstBefore(NC, *I);
2564       } else {
2565         // Otherwise, it's a call, just insert cast right after the call.
2566         InsertNewInstBefore(NC, *Caller);
2567       }
2568       Worklist.pushUsersToWorkList(*Caller);
2569     } else {
2570       NV = UndefValue::get(Caller->getType());
2571     }
2572   }
2573 
2574   if (!Caller->use_empty())
2575     replaceInstUsesWith(*Caller, NV);
2576   else if (Caller->hasValueHandle()) {
2577     if (OldRetTy == NV->getType())
2578       ValueHandleBase::ValueIsRAUWd(Caller, NV);
2579     else
2580       // We cannot call ValueIsRAUWd with a different type, and the
2581       // actual tracked value will disappear.
2582       ValueHandleBase::ValueIsDeleted(Caller);
2583   }
2584 
2585   eraseInstFromFunction(*Caller);
2586   return true;
2587 }
2588 
2589 /// Turn a call to a function created by init_trampoline / adjust_trampoline
2590 /// intrinsic pair into a direct call to the underlying function.
2591 Instruction *
2592 InstCombinerImpl::transformCallThroughTrampoline(CallBase &Call,
2593                                                  IntrinsicInst &Tramp) {
2594   Value *Callee = Call.getCalledOperand();
2595   Type *CalleeTy = Callee->getType();
2596   FunctionType *FTy = Call.getFunctionType();
2597   AttributeList Attrs = Call.getAttributes();
2598 
2599   // If the call already has the 'nest' attribute somewhere then give up -
2600   // otherwise 'nest' would occur twice after splicing in the chain.
2601   if (Attrs.hasAttrSomewhere(Attribute::Nest))
2602     return nullptr;
2603 
2604   Function *NestF = cast<Function>(Tramp.getArgOperand(1)->stripPointerCasts());
2605   FunctionType *NestFTy = NestF->getFunctionType();
2606 
2607   AttributeList NestAttrs = NestF->getAttributes();
2608   if (!NestAttrs.isEmpty()) {
2609     unsigned NestArgNo = 0;
2610     Type *NestTy = nullptr;
2611     AttributeSet NestAttr;
2612 
2613     // Look for a parameter marked with the 'nest' attribute.
2614     for (FunctionType::param_iterator I = NestFTy->param_begin(),
2615                                       E = NestFTy->param_end();
2616          I != E; ++NestArgNo, ++I) {
2617       AttributeSet AS = NestAttrs.getParamAttributes(NestArgNo);
2618       if (AS.hasAttribute(Attribute::Nest)) {
2619         // Record the parameter type and any other attributes.
2620         NestTy = *I;
2621         NestAttr = AS;
2622         break;
2623       }
2624     }
2625 
2626     if (NestTy) {
2627       std::vector<Value*> NewArgs;
2628       std::vector<AttributeSet> NewArgAttrs;
2629       NewArgs.reserve(Call.arg_size() + 1);
2630       NewArgAttrs.reserve(Call.arg_size());
2631 
2632       // Insert the nest argument into the call argument list, which may
2633       // mean appending it.  Likewise for attributes.
2634 
2635       {
2636         unsigned ArgNo = 0;
2637         auto I = Call.arg_begin(), E = Call.arg_end();
2638         do {
2639           if (ArgNo == NestArgNo) {
2640             // Add the chain argument and attributes.
2641             Value *NestVal = Tramp.getArgOperand(2);
2642             if (NestVal->getType() != NestTy)
2643               NestVal = Builder.CreateBitCast(NestVal, NestTy, "nest");
2644             NewArgs.push_back(NestVal);
2645             NewArgAttrs.push_back(NestAttr);
2646           }
2647 
2648           if (I == E)
2649             break;
2650 
2651           // Add the original argument and attributes.
2652           NewArgs.push_back(*I);
2653           NewArgAttrs.push_back(Attrs.getParamAttributes(ArgNo));
2654 
2655           ++ArgNo;
2656           ++I;
2657         } while (true);
2658       }
2659 
2660       // The trampoline may have been bitcast to a bogus type (FTy).
2661       // Handle this by synthesizing a new function type, equal to FTy
2662       // with the chain parameter inserted.
2663 
2664       std::vector<Type*> NewTypes;
2665       NewTypes.reserve(FTy->getNumParams()+1);
2666 
2667       // Insert the chain's type into the list of parameter types, which may
2668       // mean appending it.
2669       {
2670         unsigned ArgNo = 0;
2671         FunctionType::param_iterator I = FTy->param_begin(),
2672           E = FTy->param_end();
2673 
2674         do {
2675           if (ArgNo == NestArgNo)
2676             // Add the chain's type.
2677             NewTypes.push_back(NestTy);
2678 
2679           if (I == E)
2680             break;
2681 
2682           // Add the original type.
2683           NewTypes.push_back(*I);
2684 
2685           ++ArgNo;
2686           ++I;
2687         } while (true);
2688       }
2689 
2690       // Replace the trampoline call with a direct call.  Let the generic
2691       // code sort out any function type mismatches.
2692       FunctionType *NewFTy = FunctionType::get(FTy->getReturnType(), NewTypes,
2693                                                 FTy->isVarArg());
2694       Constant *NewCallee =
2695         NestF->getType() == PointerType::getUnqual(NewFTy) ?
2696         NestF : ConstantExpr::getBitCast(NestF,
2697                                          PointerType::getUnqual(NewFTy));
2698       AttributeList NewPAL =
2699           AttributeList::get(FTy->getContext(), Attrs.getFnAttributes(),
2700                              Attrs.getRetAttributes(), NewArgAttrs);
2701 
2702       SmallVector<OperandBundleDef, 1> OpBundles;
2703       Call.getOperandBundlesAsDefs(OpBundles);
2704 
2705       Instruction *NewCaller;
2706       if (InvokeInst *II = dyn_cast<InvokeInst>(&Call)) {
2707         NewCaller = InvokeInst::Create(NewFTy, NewCallee,
2708                                        II->getNormalDest(), II->getUnwindDest(),
2709                                        NewArgs, OpBundles);
2710         cast<InvokeInst>(NewCaller)->setCallingConv(II->getCallingConv());
2711         cast<InvokeInst>(NewCaller)->setAttributes(NewPAL);
2712       } else if (CallBrInst *CBI = dyn_cast<CallBrInst>(&Call)) {
2713         NewCaller =
2714             CallBrInst::Create(NewFTy, NewCallee, CBI->getDefaultDest(),
2715                                CBI->getIndirectDests(), NewArgs, OpBundles);
2716         cast<CallBrInst>(NewCaller)->setCallingConv(CBI->getCallingConv());
2717         cast<CallBrInst>(NewCaller)->setAttributes(NewPAL);
2718       } else {
2719         NewCaller = CallInst::Create(NewFTy, NewCallee, NewArgs, OpBundles);
2720         cast<CallInst>(NewCaller)->setTailCallKind(
2721             cast<CallInst>(Call).getTailCallKind());
2722         cast<CallInst>(NewCaller)->setCallingConv(
2723             cast<CallInst>(Call).getCallingConv());
2724         cast<CallInst>(NewCaller)->setAttributes(NewPAL);
2725       }
2726       NewCaller->setDebugLoc(Call.getDebugLoc());
2727 
2728       return NewCaller;
2729     }
2730   }
2731 
2732   // Replace the trampoline call with a direct call.  Since there is no 'nest'
2733   // parameter, there is no need to adjust the argument list.  Let the generic
2734   // code sort out any function type mismatches.
2735   Constant *NewCallee = ConstantExpr::getBitCast(NestF, CalleeTy);
2736   Call.setCalledFunction(FTy, NewCallee);
2737   return &Call;
2738 }
2739