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