1 //===- InstCombineCasts.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 visit functions for cast operations.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "InstCombineInternal.h"
14 #include "llvm/ADT/SetVector.h"
15 #include "llvm/Analysis/ConstantFolding.h"
16 #include "llvm/Analysis/TargetLibraryInfo.h"
17 #include "llvm/IR/DIBuilder.h"
18 #include "llvm/IR/DataLayout.h"
19 #include "llvm/IR/PatternMatch.h"
20 #include "llvm/Support/KnownBits.h"
21 #include "llvm/Transforms/InstCombine/InstCombiner.h"
22 #include <numeric>
23 using namespace llvm;
24 using namespace PatternMatch;
25 
26 #define DEBUG_TYPE "instcombine"
27 
28 /// Analyze 'Val', seeing if it is a simple linear expression.
29 /// If so, decompose it, returning some value X, such that Val is
30 /// X*Scale+Offset.
31 ///
32 static Value *decomposeSimpleLinearExpr(Value *Val, unsigned &Scale,
33                                         uint64_t &Offset) {
34   if (ConstantInt *CI = dyn_cast<ConstantInt>(Val)) {
35     Offset = CI->getZExtValue();
36     Scale  = 0;
37     return ConstantInt::get(Val->getType(), 0);
38   }
39 
40   if (BinaryOperator *I = dyn_cast<BinaryOperator>(Val)) {
41     // Cannot look past anything that might overflow.
42     OverflowingBinaryOperator *OBI = dyn_cast<OverflowingBinaryOperator>(Val);
43     if (OBI && !OBI->hasNoUnsignedWrap() && !OBI->hasNoSignedWrap()) {
44       Scale = 1;
45       Offset = 0;
46       return Val;
47     }
48 
49     if (ConstantInt *RHS = dyn_cast<ConstantInt>(I->getOperand(1))) {
50       if (I->getOpcode() == Instruction::Shl) {
51         // This is a value scaled by '1 << the shift amt'.
52         Scale = UINT64_C(1) << RHS->getZExtValue();
53         Offset = 0;
54         return I->getOperand(0);
55       }
56 
57       if (I->getOpcode() == Instruction::Mul) {
58         // This value is scaled by 'RHS'.
59         Scale = RHS->getZExtValue();
60         Offset = 0;
61         return I->getOperand(0);
62       }
63 
64       if (I->getOpcode() == Instruction::Add) {
65         // We have X+C.  Check to see if we really have (X*C2)+C1,
66         // where C1 is divisible by C2.
67         unsigned SubScale;
68         Value *SubVal =
69           decomposeSimpleLinearExpr(I->getOperand(0), SubScale, Offset);
70         Offset += RHS->getZExtValue();
71         Scale = SubScale;
72         return SubVal;
73       }
74     }
75   }
76 
77   // Otherwise, we can't look past this.
78   Scale = 1;
79   Offset = 0;
80   return Val;
81 }
82 
83 /// If we find a cast of an allocation instruction, try to eliminate the cast by
84 /// moving the type information into the alloc.
85 Instruction *InstCombinerImpl::PromoteCastOfAllocation(BitCastInst &CI,
86                                                        AllocaInst &AI) {
87   PointerType *PTy = cast<PointerType>(CI.getType());
88 
89   IRBuilderBase::InsertPointGuard Guard(Builder);
90   Builder.SetInsertPoint(&AI);
91 
92   // Get the type really allocated and the type casted to.
93   Type *AllocElTy = AI.getAllocatedType();
94   Type *CastElTy = PTy->getElementType();
95   if (!AllocElTy->isSized() || !CastElTy->isSized()) return nullptr;
96 
97   // This optimisation does not work for cases where the cast type
98   // is scalable and the allocated type is not. This because we need to
99   // know how many times the casted type fits into the allocated type.
100   // For the opposite case where the allocated type is scalable and the
101   // cast type is not this leads to poor code quality due to the
102   // introduction of 'vscale' into the calculations. It seems better to
103   // bail out for this case too until we've done a proper cost-benefit
104   // analysis.
105   bool AllocIsScalable = isa<ScalableVectorType>(AllocElTy);
106   bool CastIsScalable = isa<ScalableVectorType>(CastElTy);
107   if (AllocIsScalable != CastIsScalable) return nullptr;
108 
109   Align AllocElTyAlign = DL.getABITypeAlign(AllocElTy);
110   Align CastElTyAlign = DL.getABITypeAlign(CastElTy);
111   if (CastElTyAlign < AllocElTyAlign) return nullptr;
112 
113   // If the allocation has multiple uses, only promote it if we are strictly
114   // increasing the alignment of the resultant allocation.  If we keep it the
115   // same, we open the door to infinite loops of various kinds.
116   if (!AI.hasOneUse() && CastElTyAlign == AllocElTyAlign) return nullptr;
117 
118   // The alloc and cast types should be either both fixed or both scalable.
119   uint64_t AllocElTySize = DL.getTypeAllocSize(AllocElTy).getKnownMinSize();
120   uint64_t CastElTySize = DL.getTypeAllocSize(CastElTy).getKnownMinSize();
121   if (CastElTySize == 0 || AllocElTySize == 0) return nullptr;
122 
123   // If the allocation has multiple uses, only promote it if we're not
124   // shrinking the amount of memory being allocated.
125   uint64_t AllocElTyStoreSize = DL.getTypeStoreSize(AllocElTy).getKnownMinSize();
126   uint64_t CastElTyStoreSize = DL.getTypeStoreSize(CastElTy).getKnownMinSize();
127   if (!AI.hasOneUse() && CastElTyStoreSize < AllocElTyStoreSize) return nullptr;
128 
129   // See if we can satisfy the modulus by pulling a scale out of the array
130   // size argument.
131   unsigned ArraySizeScale;
132   uint64_t ArrayOffset;
133   Value *NumElements = // See if the array size is a decomposable linear expr.
134     decomposeSimpleLinearExpr(AI.getOperand(0), ArraySizeScale, ArrayOffset);
135 
136   // If we can now satisfy the modulus, by using a non-1 scale, we really can
137   // do the xform.
138   if ((AllocElTySize*ArraySizeScale) % CastElTySize != 0 ||
139       (AllocElTySize*ArrayOffset   ) % CastElTySize != 0) return nullptr;
140 
141   // We don't currently support arrays of scalable types.
142   assert(!AllocIsScalable || (ArrayOffset == 1 && ArraySizeScale == 0));
143 
144   unsigned Scale = (AllocElTySize*ArraySizeScale)/CastElTySize;
145   Value *Amt = nullptr;
146   if (Scale == 1) {
147     Amt = NumElements;
148   } else {
149     Amt = ConstantInt::get(AI.getArraySize()->getType(), Scale);
150     // Insert before the alloca, not before the cast.
151     Amt = Builder.CreateMul(Amt, NumElements);
152   }
153 
154   if (uint64_t Offset = (AllocElTySize*ArrayOffset)/CastElTySize) {
155     Value *Off = ConstantInt::get(AI.getArraySize()->getType(),
156                                   Offset, true);
157     Amt = Builder.CreateAdd(Amt, Off);
158   }
159 
160   AllocaInst *New = Builder.CreateAlloca(CastElTy, Amt);
161   New->setAlignment(AI.getAlign());
162   New->takeName(&AI);
163   New->setUsedWithInAlloca(AI.isUsedWithInAlloca());
164 
165   // If the allocation has multiple real uses, insert a cast and change all
166   // things that used it to use the new cast.  This will also hack on CI, but it
167   // will die soon.
168   if (!AI.hasOneUse()) {
169     // New is the allocation instruction, pointer typed. AI is the original
170     // allocation instruction, also pointer typed. Thus, cast to use is BitCast.
171     Value *NewCast = Builder.CreateBitCast(New, AI.getType(), "tmpcast");
172     replaceInstUsesWith(AI, NewCast);
173     eraseInstFromFunction(AI);
174   }
175   return replaceInstUsesWith(CI, New);
176 }
177 
178 /// Given an expression that CanEvaluateTruncated or CanEvaluateSExtd returns
179 /// true for, actually insert the code to evaluate the expression.
180 Value *InstCombinerImpl::EvaluateInDifferentType(Value *V, Type *Ty,
181                                                  bool isSigned) {
182   if (Constant *C = dyn_cast<Constant>(V)) {
183     C = ConstantExpr::getIntegerCast(C, Ty, isSigned /*Sext or ZExt*/);
184     // If we got a constantexpr back, try to simplify it with DL info.
185     return ConstantFoldConstant(C, DL, &TLI);
186   }
187 
188   // Otherwise, it must be an instruction.
189   Instruction *I = cast<Instruction>(V);
190   Instruction *Res = nullptr;
191   unsigned Opc = I->getOpcode();
192   switch (Opc) {
193   case Instruction::Add:
194   case Instruction::Sub:
195   case Instruction::Mul:
196   case Instruction::And:
197   case Instruction::Or:
198   case Instruction::Xor:
199   case Instruction::AShr:
200   case Instruction::LShr:
201   case Instruction::Shl:
202   case Instruction::UDiv:
203   case Instruction::URem: {
204     Value *LHS = EvaluateInDifferentType(I->getOperand(0), Ty, isSigned);
205     Value *RHS = EvaluateInDifferentType(I->getOperand(1), Ty, isSigned);
206     Res = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
207     break;
208   }
209   case Instruction::Trunc:
210   case Instruction::ZExt:
211   case Instruction::SExt:
212     // If the source type of the cast is the type we're trying for then we can
213     // just return the source.  There's no need to insert it because it is not
214     // new.
215     if (I->getOperand(0)->getType() == Ty)
216       return I->getOperand(0);
217 
218     // Otherwise, must be the same type of cast, so just reinsert a new one.
219     // This also handles the case of zext(trunc(x)) -> zext(x).
220     Res = CastInst::CreateIntegerCast(I->getOperand(0), Ty,
221                                       Opc == Instruction::SExt);
222     break;
223   case Instruction::Select: {
224     Value *True = EvaluateInDifferentType(I->getOperand(1), Ty, isSigned);
225     Value *False = EvaluateInDifferentType(I->getOperand(2), Ty, isSigned);
226     Res = SelectInst::Create(I->getOperand(0), True, False);
227     break;
228   }
229   case Instruction::PHI: {
230     PHINode *OPN = cast<PHINode>(I);
231     PHINode *NPN = PHINode::Create(Ty, OPN->getNumIncomingValues());
232     for (unsigned i = 0, e = OPN->getNumIncomingValues(); i != e; ++i) {
233       Value *V =
234           EvaluateInDifferentType(OPN->getIncomingValue(i), Ty, isSigned);
235       NPN->addIncoming(V, OPN->getIncomingBlock(i));
236     }
237     Res = NPN;
238     break;
239   }
240   default:
241     // TODO: Can handle more cases here.
242     llvm_unreachable("Unreachable!");
243   }
244 
245   Res->takeName(I);
246   return InsertNewInstWith(Res, *I);
247 }
248 
249 Instruction::CastOps
250 InstCombinerImpl::isEliminableCastPair(const CastInst *CI1,
251                                        const CastInst *CI2) {
252   Type *SrcTy = CI1->getSrcTy();
253   Type *MidTy = CI1->getDestTy();
254   Type *DstTy = CI2->getDestTy();
255 
256   Instruction::CastOps firstOp = CI1->getOpcode();
257   Instruction::CastOps secondOp = CI2->getOpcode();
258   Type *SrcIntPtrTy =
259       SrcTy->isPtrOrPtrVectorTy() ? DL.getIntPtrType(SrcTy) : nullptr;
260   Type *MidIntPtrTy =
261       MidTy->isPtrOrPtrVectorTy() ? DL.getIntPtrType(MidTy) : nullptr;
262   Type *DstIntPtrTy =
263       DstTy->isPtrOrPtrVectorTy() ? DL.getIntPtrType(DstTy) : nullptr;
264   unsigned Res = CastInst::isEliminableCastPair(firstOp, secondOp, SrcTy, MidTy,
265                                                 DstTy, SrcIntPtrTy, MidIntPtrTy,
266                                                 DstIntPtrTy);
267 
268   // We don't want to form an inttoptr or ptrtoint that converts to an integer
269   // type that differs from the pointer size.
270   if ((Res == Instruction::IntToPtr && SrcTy != DstIntPtrTy) ||
271       (Res == Instruction::PtrToInt && DstTy != SrcIntPtrTy))
272     Res = 0;
273 
274   return Instruction::CastOps(Res);
275 }
276 
277 /// Implement the transforms common to all CastInst visitors.
278 Instruction *InstCombinerImpl::commonCastTransforms(CastInst &CI) {
279   Value *Src = CI.getOperand(0);
280 
281   // Try to eliminate a cast of a cast.
282   if (auto *CSrc = dyn_cast<CastInst>(Src)) {   // A->B->C cast
283     if (Instruction::CastOps NewOpc = isEliminableCastPair(CSrc, &CI)) {
284       // The first cast (CSrc) is eliminable so we need to fix up or replace
285       // the second cast (CI). CSrc will then have a good chance of being dead.
286       auto *Ty = CI.getType();
287       auto *Res = CastInst::Create(NewOpc, CSrc->getOperand(0), Ty);
288       // Point debug users of the dying cast to the new one.
289       if (CSrc->hasOneUse())
290         replaceAllDbgUsesWith(*CSrc, *Res, CI, DT);
291       return Res;
292     }
293   }
294 
295   if (auto *Sel = dyn_cast<SelectInst>(Src)) {
296     // We are casting a select. Try to fold the cast into the select if the
297     // select does not have a compare instruction with matching operand types
298     // or the select is likely better done in a narrow type.
299     // Creating a select with operands that are different sizes than its
300     // condition may inhibit other folds and lead to worse codegen.
301     auto *Cmp = dyn_cast<CmpInst>(Sel->getCondition());
302     if (!Cmp || Cmp->getOperand(0)->getType() != Sel->getType() ||
303         (CI.getOpcode() == Instruction::Trunc &&
304          shouldChangeType(CI.getSrcTy(), CI.getType()))) {
305       if (Instruction *NV = FoldOpIntoSelect(CI, Sel)) {
306         replaceAllDbgUsesWith(*Sel, *NV, CI, DT);
307         return NV;
308       }
309     }
310   }
311 
312   // If we are casting a PHI, then fold the cast into the PHI.
313   if (auto *PN = dyn_cast<PHINode>(Src)) {
314     // Don't do this if it would create a PHI node with an illegal type from a
315     // legal type.
316     if (!Src->getType()->isIntegerTy() || !CI.getType()->isIntegerTy() ||
317         shouldChangeType(CI.getSrcTy(), CI.getType()))
318       if (Instruction *NV = foldOpIntoPhi(CI, PN))
319         return NV;
320   }
321 
322   return nullptr;
323 }
324 
325 /// Constants and extensions/truncates from the destination type are always
326 /// free to be evaluated in that type. This is a helper for canEvaluate*.
327 static bool canAlwaysEvaluateInType(Value *V, Type *Ty) {
328   if (isa<Constant>(V))
329     return true;
330   Value *X;
331   if ((match(V, m_ZExtOrSExt(m_Value(X))) || match(V, m_Trunc(m_Value(X)))) &&
332       X->getType() == Ty)
333     return true;
334 
335   return false;
336 }
337 
338 /// Filter out values that we can not evaluate in the destination type for free.
339 /// This is a helper for canEvaluate*.
340 static bool canNotEvaluateInType(Value *V, Type *Ty) {
341   assert(!isa<Constant>(V) && "Constant should already be handled.");
342   if (!isa<Instruction>(V))
343     return true;
344   // We don't extend or shrink something that has multiple uses --  doing so
345   // would require duplicating the instruction which isn't profitable.
346   if (!V->hasOneUse())
347     return true;
348 
349   return false;
350 }
351 
352 /// Return true if we can evaluate the specified expression tree as type Ty
353 /// instead of its larger type, and arrive with the same value.
354 /// This is used by code that tries to eliminate truncates.
355 ///
356 /// Ty will always be a type smaller than V.  We should return true if trunc(V)
357 /// can be computed by computing V in the smaller type.  If V is an instruction,
358 /// then trunc(inst(x,y)) can be computed as inst(trunc(x),trunc(y)), which only
359 /// makes sense if x and y can be efficiently truncated.
360 ///
361 /// This function works on both vectors and scalars.
362 ///
363 static bool canEvaluateTruncated(Value *V, Type *Ty, InstCombinerImpl &IC,
364                                  Instruction *CxtI) {
365   if (canAlwaysEvaluateInType(V, Ty))
366     return true;
367   if (canNotEvaluateInType(V, Ty))
368     return false;
369 
370   auto *I = cast<Instruction>(V);
371   Type *OrigTy = V->getType();
372   switch (I->getOpcode()) {
373   case Instruction::Add:
374   case Instruction::Sub:
375   case Instruction::Mul:
376   case Instruction::And:
377   case Instruction::Or:
378   case Instruction::Xor:
379     // These operators can all arbitrarily be extended or truncated.
380     return canEvaluateTruncated(I->getOperand(0), Ty, IC, CxtI) &&
381            canEvaluateTruncated(I->getOperand(1), Ty, IC, CxtI);
382 
383   case Instruction::UDiv:
384   case Instruction::URem: {
385     // UDiv and URem can be truncated if all the truncated bits are zero.
386     uint32_t OrigBitWidth = OrigTy->getScalarSizeInBits();
387     uint32_t BitWidth = Ty->getScalarSizeInBits();
388     assert(BitWidth < OrigBitWidth && "Unexpected bitwidths!");
389     APInt Mask = APInt::getBitsSetFrom(OrigBitWidth, BitWidth);
390     if (IC.MaskedValueIsZero(I->getOperand(0), Mask, 0, CxtI) &&
391         IC.MaskedValueIsZero(I->getOperand(1), Mask, 0, CxtI)) {
392       return canEvaluateTruncated(I->getOperand(0), Ty, IC, CxtI) &&
393              canEvaluateTruncated(I->getOperand(1), Ty, IC, CxtI);
394     }
395     break;
396   }
397   case Instruction::Shl: {
398     // If we are truncating the result of this SHL, and if it's a shift of an
399     // inrange amount, we can always perform a SHL in a smaller type.
400     uint32_t BitWidth = Ty->getScalarSizeInBits();
401     KnownBits AmtKnownBits =
402         llvm::computeKnownBits(I->getOperand(1), IC.getDataLayout());
403     if (AmtKnownBits.getMaxValue().ult(BitWidth))
404       return canEvaluateTruncated(I->getOperand(0), Ty, IC, CxtI) &&
405              canEvaluateTruncated(I->getOperand(1), Ty, IC, CxtI);
406     break;
407   }
408   case Instruction::LShr: {
409     // If this is a truncate of a logical shr, we can truncate it to a smaller
410     // lshr iff we know that the bits we would otherwise be shifting in are
411     // already zeros.
412     // TODO: It is enough to check that the bits we would be shifting in are
413     //       zero - use AmtKnownBits.getMaxValue().
414     uint32_t OrigBitWidth = OrigTy->getScalarSizeInBits();
415     uint32_t BitWidth = Ty->getScalarSizeInBits();
416     KnownBits AmtKnownBits =
417         llvm::computeKnownBits(I->getOperand(1), IC.getDataLayout());
418     APInt ShiftedBits = APInt::getBitsSetFrom(OrigBitWidth, BitWidth);
419     if (AmtKnownBits.getMaxValue().ult(BitWidth) &&
420         IC.MaskedValueIsZero(I->getOperand(0), ShiftedBits, 0, CxtI)) {
421       return canEvaluateTruncated(I->getOperand(0), Ty, IC, CxtI) &&
422              canEvaluateTruncated(I->getOperand(1), Ty, IC, CxtI);
423     }
424     break;
425   }
426   case Instruction::AShr: {
427     // If this is a truncate of an arithmetic shr, we can truncate it to a
428     // smaller ashr iff we know that all the bits from the sign bit of the
429     // original type and the sign bit of the truncate type are similar.
430     // TODO: It is enough to check that the bits we would be shifting in are
431     //       similar to sign bit of the truncate type.
432     uint32_t OrigBitWidth = OrigTy->getScalarSizeInBits();
433     uint32_t BitWidth = Ty->getScalarSizeInBits();
434     KnownBits AmtKnownBits =
435         llvm::computeKnownBits(I->getOperand(1), IC.getDataLayout());
436     unsigned ShiftedBits = OrigBitWidth - BitWidth;
437     if (AmtKnownBits.getMaxValue().ult(BitWidth) &&
438         ShiftedBits < IC.ComputeNumSignBits(I->getOperand(0), 0, CxtI))
439       return canEvaluateTruncated(I->getOperand(0), Ty, IC, CxtI) &&
440              canEvaluateTruncated(I->getOperand(1), Ty, IC, CxtI);
441     break;
442   }
443   case Instruction::Trunc:
444     // trunc(trunc(x)) -> trunc(x)
445     return true;
446   case Instruction::ZExt:
447   case Instruction::SExt:
448     // trunc(ext(x)) -> ext(x) if the source type is smaller than the new dest
449     // trunc(ext(x)) -> trunc(x) if the source type is larger than the new dest
450     return true;
451   case Instruction::Select: {
452     SelectInst *SI = cast<SelectInst>(I);
453     return canEvaluateTruncated(SI->getTrueValue(), Ty, IC, CxtI) &&
454            canEvaluateTruncated(SI->getFalseValue(), Ty, IC, CxtI);
455   }
456   case Instruction::PHI: {
457     // We can change a phi if we can change all operands.  Note that we never
458     // get into trouble with cyclic PHIs here because we only consider
459     // instructions with a single use.
460     PHINode *PN = cast<PHINode>(I);
461     for (Value *IncValue : PN->incoming_values())
462       if (!canEvaluateTruncated(IncValue, Ty, IC, CxtI))
463         return false;
464     return true;
465   }
466   default:
467     // TODO: Can handle more cases here.
468     break;
469   }
470 
471   return false;
472 }
473 
474 /// Given a vector that is bitcast to an integer, optionally logically
475 /// right-shifted, and truncated, convert it to an extractelement.
476 /// Example (big endian):
477 ///   trunc (lshr (bitcast <4 x i32> %X to i128), 32) to i32
478 ///   --->
479 ///   extractelement <4 x i32> %X, 1
480 static Instruction *foldVecTruncToExtElt(TruncInst &Trunc,
481                                          InstCombinerImpl &IC) {
482   Value *TruncOp = Trunc.getOperand(0);
483   Type *DestType = Trunc.getType();
484   if (!TruncOp->hasOneUse() || !isa<IntegerType>(DestType))
485     return nullptr;
486 
487   Value *VecInput = nullptr;
488   ConstantInt *ShiftVal = nullptr;
489   if (!match(TruncOp, m_CombineOr(m_BitCast(m_Value(VecInput)),
490                                   m_LShr(m_BitCast(m_Value(VecInput)),
491                                          m_ConstantInt(ShiftVal)))) ||
492       !isa<VectorType>(VecInput->getType()))
493     return nullptr;
494 
495   VectorType *VecType = cast<VectorType>(VecInput->getType());
496   unsigned VecWidth = VecType->getPrimitiveSizeInBits();
497   unsigned DestWidth = DestType->getPrimitiveSizeInBits();
498   unsigned ShiftAmount = ShiftVal ? ShiftVal->getZExtValue() : 0;
499 
500   if ((VecWidth % DestWidth != 0) || (ShiftAmount % DestWidth != 0))
501     return nullptr;
502 
503   // If the element type of the vector doesn't match the result type,
504   // bitcast it to a vector type that we can extract from.
505   unsigned NumVecElts = VecWidth / DestWidth;
506   if (VecType->getElementType() != DestType) {
507     VecType = FixedVectorType::get(DestType, NumVecElts);
508     VecInput = IC.Builder.CreateBitCast(VecInput, VecType, "bc");
509   }
510 
511   unsigned Elt = ShiftAmount / DestWidth;
512   if (IC.getDataLayout().isBigEndian())
513     Elt = NumVecElts - 1 - Elt;
514 
515   return ExtractElementInst::Create(VecInput, IC.Builder.getInt32(Elt));
516 }
517 
518 /// Rotate left/right may occur in a wider type than necessary because of type
519 /// promotion rules. Try to narrow the inputs and convert to funnel shift.
520 Instruction *InstCombinerImpl::narrowRotate(TruncInst &Trunc) {
521   assert((isa<VectorType>(Trunc.getSrcTy()) ||
522           shouldChangeType(Trunc.getSrcTy(), Trunc.getType())) &&
523          "Don't narrow to an illegal scalar type");
524 
525   // Bail out on strange types. It is possible to handle some of these patterns
526   // even with non-power-of-2 sizes, but it is not a likely scenario.
527   Type *DestTy = Trunc.getType();
528   unsigned NarrowWidth = DestTy->getScalarSizeInBits();
529   if (!isPowerOf2_32(NarrowWidth))
530     return nullptr;
531 
532   // First, find an or'd pair of opposite shifts with the same shifted operand:
533   // trunc (or (lshr ShVal, ShAmt0), (shl ShVal, ShAmt1))
534   Value *Or0, *Or1;
535   if (!match(Trunc.getOperand(0), m_OneUse(m_Or(m_Value(Or0), m_Value(Or1)))))
536     return nullptr;
537 
538   Value *ShVal, *ShAmt0, *ShAmt1;
539   if (!match(Or0, m_OneUse(m_LogicalShift(m_Value(ShVal), m_Value(ShAmt0)))) ||
540       !match(Or1, m_OneUse(m_LogicalShift(m_Specific(ShVal), m_Value(ShAmt1)))))
541     return nullptr;
542 
543   auto ShiftOpcode0 = cast<BinaryOperator>(Or0)->getOpcode();
544   auto ShiftOpcode1 = cast<BinaryOperator>(Or1)->getOpcode();
545   if (ShiftOpcode0 == ShiftOpcode1)
546     return nullptr;
547 
548   // Match the shift amount operands for a rotate pattern. This always matches
549   // a subtraction on the R operand.
550   auto matchShiftAmount = [](Value *L, Value *R, unsigned Width) -> Value * {
551     // The shift amounts may add up to the narrow bit width:
552     // (shl ShVal, L) | (lshr ShVal, Width - L)
553     if (match(R, m_OneUse(m_Sub(m_SpecificInt(Width), m_Specific(L)))))
554       return L;
555 
556     // The shift amount may be masked with negation:
557     // (shl ShVal, (X & (Width - 1))) | (lshr ShVal, ((-X) & (Width - 1)))
558     Value *X;
559     unsigned Mask = Width - 1;
560     if (match(L, m_And(m_Value(X), m_SpecificInt(Mask))) &&
561         match(R, m_And(m_Neg(m_Specific(X)), m_SpecificInt(Mask))))
562       return X;
563 
564     // Same as above, but the shift amount may be extended after masking:
565     if (match(L, m_ZExt(m_And(m_Value(X), m_SpecificInt(Mask)))) &&
566         match(R, m_ZExt(m_And(m_Neg(m_Specific(X)), m_SpecificInt(Mask)))))
567       return X;
568 
569     return nullptr;
570   };
571 
572   Value *ShAmt = matchShiftAmount(ShAmt0, ShAmt1, NarrowWidth);
573   bool SubIsOnLHS = false;
574   if (!ShAmt) {
575     ShAmt = matchShiftAmount(ShAmt1, ShAmt0, NarrowWidth);
576     SubIsOnLHS = true;
577   }
578   if (!ShAmt)
579     return nullptr;
580 
581   // The shifted value must have high zeros in the wide type. Typically, this
582   // will be a zext, but it could also be the result of an 'and' or 'shift'.
583   unsigned WideWidth = Trunc.getSrcTy()->getScalarSizeInBits();
584   APInt HiBitMask = APInt::getHighBitsSet(WideWidth, WideWidth - NarrowWidth);
585   if (!MaskedValueIsZero(ShVal, HiBitMask, 0, &Trunc))
586     return nullptr;
587 
588   // We have an unnecessarily wide rotate!
589   // trunc (or (lshr ShVal, ShAmt), (shl ShVal, BitWidth - ShAmt))
590   // Narrow the inputs and convert to funnel shift intrinsic:
591   // llvm.fshl.i8(trunc(ShVal), trunc(ShVal), trunc(ShAmt))
592   Value *NarrowShAmt = Builder.CreateTrunc(ShAmt, DestTy);
593   Value *X = Builder.CreateTrunc(ShVal, DestTy);
594   bool IsFshl = (!SubIsOnLHS && ShiftOpcode0 == BinaryOperator::Shl) ||
595                 (SubIsOnLHS && ShiftOpcode1 == BinaryOperator::Shl);
596   Intrinsic::ID IID = IsFshl ? Intrinsic::fshl : Intrinsic::fshr;
597   Function *F = Intrinsic::getDeclaration(Trunc.getModule(), IID, DestTy);
598   return IntrinsicInst::Create(F, { X, X, NarrowShAmt });
599 }
600 
601 /// Try to narrow the width of math or bitwise logic instructions by pulling a
602 /// truncate ahead of binary operators.
603 /// TODO: Transforms for truncated shifts should be moved into here.
604 Instruction *InstCombinerImpl::narrowBinOp(TruncInst &Trunc) {
605   Type *SrcTy = Trunc.getSrcTy();
606   Type *DestTy = Trunc.getType();
607   if (!isa<VectorType>(SrcTy) && !shouldChangeType(SrcTy, DestTy))
608     return nullptr;
609 
610   BinaryOperator *BinOp;
611   if (!match(Trunc.getOperand(0), m_OneUse(m_BinOp(BinOp))))
612     return nullptr;
613 
614   Value *BinOp0 = BinOp->getOperand(0);
615   Value *BinOp1 = BinOp->getOperand(1);
616   switch (BinOp->getOpcode()) {
617   case Instruction::And:
618   case Instruction::Or:
619   case Instruction::Xor:
620   case Instruction::Add:
621   case Instruction::Sub:
622   case Instruction::Mul: {
623     Constant *C;
624     if (match(BinOp0, m_Constant(C))) {
625       // trunc (binop C, X) --> binop (trunc C', X)
626       Constant *NarrowC = ConstantExpr::getTrunc(C, DestTy);
627       Value *TruncX = Builder.CreateTrunc(BinOp1, DestTy);
628       return BinaryOperator::Create(BinOp->getOpcode(), NarrowC, TruncX);
629     }
630     if (match(BinOp1, m_Constant(C))) {
631       // trunc (binop X, C) --> binop (trunc X, C')
632       Constant *NarrowC = ConstantExpr::getTrunc(C, DestTy);
633       Value *TruncX = Builder.CreateTrunc(BinOp0, DestTy);
634       return BinaryOperator::Create(BinOp->getOpcode(), TruncX, NarrowC);
635     }
636     Value *X;
637     if (match(BinOp0, m_ZExtOrSExt(m_Value(X))) && X->getType() == DestTy) {
638       // trunc (binop (ext X), Y) --> binop X, (trunc Y)
639       Value *NarrowOp1 = Builder.CreateTrunc(BinOp1, DestTy);
640       return BinaryOperator::Create(BinOp->getOpcode(), X, NarrowOp1);
641     }
642     if (match(BinOp1, m_ZExtOrSExt(m_Value(X))) && X->getType() == DestTy) {
643       // trunc (binop Y, (ext X)) --> binop (trunc Y), X
644       Value *NarrowOp0 = Builder.CreateTrunc(BinOp0, DestTy);
645       return BinaryOperator::Create(BinOp->getOpcode(), NarrowOp0, X);
646     }
647     break;
648   }
649 
650   default: break;
651   }
652 
653   if (Instruction *NarrowOr = narrowRotate(Trunc))
654     return NarrowOr;
655 
656   return nullptr;
657 }
658 
659 /// Try to narrow the width of a splat shuffle. This could be generalized to any
660 /// shuffle with a constant operand, but we limit the transform to avoid
661 /// creating a shuffle type that targets may not be able to lower effectively.
662 static Instruction *shrinkSplatShuffle(TruncInst &Trunc,
663                                        InstCombiner::BuilderTy &Builder) {
664   auto *Shuf = dyn_cast<ShuffleVectorInst>(Trunc.getOperand(0));
665   if (Shuf && Shuf->hasOneUse() && isa<UndefValue>(Shuf->getOperand(1)) &&
666       is_splat(Shuf->getShuffleMask()) &&
667       Shuf->getType() == Shuf->getOperand(0)->getType()) {
668     // trunc (shuf X, Undef, SplatMask) --> shuf (trunc X), Undef, SplatMask
669     Constant *NarrowUndef = UndefValue::get(Trunc.getType());
670     Value *NarrowOp = Builder.CreateTrunc(Shuf->getOperand(0), Trunc.getType());
671     return new ShuffleVectorInst(NarrowOp, NarrowUndef, Shuf->getShuffleMask());
672   }
673 
674   return nullptr;
675 }
676 
677 /// Try to narrow the width of an insert element. This could be generalized for
678 /// any vector constant, but we limit the transform to insertion into undef to
679 /// avoid potential backend problems from unsupported insertion widths. This
680 /// could also be extended to handle the case of inserting a scalar constant
681 /// into a vector variable.
682 static Instruction *shrinkInsertElt(CastInst &Trunc,
683                                     InstCombiner::BuilderTy &Builder) {
684   Instruction::CastOps Opcode = Trunc.getOpcode();
685   assert((Opcode == Instruction::Trunc || Opcode == Instruction::FPTrunc) &&
686          "Unexpected instruction for shrinking");
687 
688   auto *InsElt = dyn_cast<InsertElementInst>(Trunc.getOperand(0));
689   if (!InsElt || !InsElt->hasOneUse())
690     return nullptr;
691 
692   Type *DestTy = Trunc.getType();
693   Type *DestScalarTy = DestTy->getScalarType();
694   Value *VecOp = InsElt->getOperand(0);
695   Value *ScalarOp = InsElt->getOperand(1);
696   Value *Index = InsElt->getOperand(2);
697 
698   if (isa<UndefValue>(VecOp)) {
699     // trunc   (inselt undef, X, Index) --> inselt undef,   (trunc X), Index
700     // fptrunc (inselt undef, X, Index) --> inselt undef, (fptrunc X), Index
701     UndefValue *NarrowUndef = UndefValue::get(DestTy);
702     Value *NarrowOp = Builder.CreateCast(Opcode, ScalarOp, DestScalarTy);
703     return InsertElementInst::Create(NarrowUndef, NarrowOp, Index);
704   }
705 
706   return nullptr;
707 }
708 
709 Instruction *InstCombinerImpl::visitTrunc(TruncInst &Trunc) {
710   if (Instruction *Result = commonCastTransforms(Trunc))
711     return Result;
712 
713   Value *Src = Trunc.getOperand(0);
714   Type *DestTy = Trunc.getType(), *SrcTy = Src->getType();
715   unsigned DestWidth = DestTy->getScalarSizeInBits();
716   unsigned SrcWidth = SrcTy->getScalarSizeInBits();
717 
718   // Attempt to truncate the entire input expression tree to the destination
719   // type.   Only do this if the dest type is a simple type, don't convert the
720   // expression tree to something weird like i93 unless the source is also
721   // strange.
722   if ((DestTy->isVectorTy() || shouldChangeType(SrcTy, DestTy)) &&
723       canEvaluateTruncated(Src, DestTy, *this, &Trunc)) {
724 
725     // If this cast is a truncate, evaluting in a different type always
726     // eliminates the cast, so it is always a win.
727     LLVM_DEBUG(
728         dbgs() << "ICE: EvaluateInDifferentType converting expression type"
729                   " to avoid cast: "
730                << Trunc << '\n');
731     Value *Res = EvaluateInDifferentType(Src, DestTy, false);
732     assert(Res->getType() == DestTy);
733     return replaceInstUsesWith(Trunc, Res);
734   }
735 
736   // For integer types, check if we can shorten the entire input expression to
737   // DestWidth * 2, which won't allow removing the truncate, but reducing the
738   // width may enable further optimizations, e.g. allowing for larger
739   // vectorization factors.
740   if (auto *DestITy = dyn_cast<IntegerType>(DestTy)) {
741     if (DestWidth * 2 < SrcWidth) {
742       auto *NewDestTy = DestITy->getExtendedType();
743       if (shouldChangeType(SrcTy, NewDestTy) &&
744           canEvaluateTruncated(Src, NewDestTy, *this, &Trunc)) {
745         LLVM_DEBUG(
746             dbgs() << "ICE: EvaluateInDifferentType converting expression type"
747                       " to reduce the width of operand of"
748                    << Trunc << '\n');
749         Value *Res = EvaluateInDifferentType(Src, NewDestTy, false);
750         return new TruncInst(Res, DestTy);
751       }
752     }
753   }
754 
755   // Test if the trunc is the user of a select which is part of a
756   // minimum or maximum operation. If so, don't do any more simplification.
757   // Even simplifying demanded bits can break the canonical form of a
758   // min/max.
759   Value *LHS, *RHS;
760   if (SelectInst *Sel = dyn_cast<SelectInst>(Src))
761     if (matchSelectPattern(Sel, LHS, RHS).Flavor != SPF_UNKNOWN)
762       return nullptr;
763 
764   // See if we can simplify any instructions used by the input whose sole
765   // purpose is to compute bits we don't care about.
766   if (SimplifyDemandedInstructionBits(Trunc))
767     return &Trunc;
768 
769   if (DestWidth == 1) {
770     Value *Zero = Constant::getNullValue(SrcTy);
771     if (DestTy->isIntegerTy()) {
772       // Canonicalize trunc x to i1 -> icmp ne (and x, 1), 0 (scalar only).
773       // TODO: We canonicalize to more instructions here because we are probably
774       // lacking equivalent analysis for trunc relative to icmp. There may also
775       // be codegen concerns. If those trunc limitations were removed, we could
776       // remove this transform.
777       Value *And = Builder.CreateAnd(Src, ConstantInt::get(SrcTy, 1));
778       return new ICmpInst(ICmpInst::ICMP_NE, And, Zero);
779     }
780 
781     // For vectors, we do not canonicalize all truncs to icmp, so optimize
782     // patterns that would be covered within visitICmpInst.
783     Value *X;
784     Constant *C;
785     if (match(Src, m_OneUse(m_LShr(m_Value(X), m_Constant(C))))) {
786       // trunc (lshr X, C) to i1 --> icmp ne (and X, C'), 0
787       Constant *One = ConstantInt::get(SrcTy, APInt(SrcWidth, 1));
788       Constant *MaskC = ConstantExpr::getShl(One, C);
789       Value *And = Builder.CreateAnd(X, MaskC);
790       return new ICmpInst(ICmpInst::ICMP_NE, And, Zero);
791     }
792     if (match(Src, m_OneUse(m_c_Or(m_LShr(m_Value(X), m_Constant(C)),
793                                    m_Deferred(X))))) {
794       // trunc (or (lshr X, C), X) to i1 --> icmp ne (and X, C'), 0
795       Constant *One = ConstantInt::get(SrcTy, APInt(SrcWidth, 1));
796       Constant *MaskC = ConstantExpr::getShl(One, C);
797       MaskC = ConstantExpr::getOr(MaskC, One);
798       Value *And = Builder.CreateAnd(X, MaskC);
799       return new ICmpInst(ICmpInst::ICMP_NE, And, Zero);
800     }
801   }
802 
803   Value *A;
804   Constant *C;
805   if (match(Src, m_LShr(m_SExt(m_Value(A)), m_Constant(C)))) {
806     unsigned AWidth = A->getType()->getScalarSizeInBits();
807     unsigned MaxShiftAmt = SrcWidth - std::max(DestWidth, AWidth);
808     auto *OldSh = cast<Instruction>(Src);
809     bool IsExact = OldSh->isExact();
810 
811     // If the shift is small enough, all zero bits created by the shift are
812     // removed by the trunc.
813     // TODO: Support passing through undef shift amounts - these currently get
814     // clamped to MaxAmt.
815     if (match(C, m_SpecificInt_ICMP(ICmpInst::ICMP_ULE,
816                                     APInt(SrcWidth, MaxShiftAmt)))) {
817       // trunc (lshr (sext A), C) --> ashr A, C
818       if (A->getType() == DestTy) {
819         Constant *MaxAmt = ConstantInt::get(SrcTy, DestWidth - 1, false);
820         Constant *ShAmt = ConstantExpr::getUMin(C, MaxAmt);
821         ShAmt = ConstantExpr::getTrunc(ShAmt, A->getType());
822         return IsExact ? BinaryOperator::CreateExactAShr(A, ShAmt)
823                        : BinaryOperator::CreateAShr(A, ShAmt);
824       }
825       // The types are mismatched, so create a cast after shifting:
826       // trunc (lshr (sext A), C) --> sext/trunc (ashr A, C)
827       if (Src->hasOneUse()) {
828         Constant *MaxAmt = ConstantInt::get(SrcTy, AWidth - 1, false);
829         Constant *ShAmt = ConstantExpr::getUMin(C, MaxAmt);
830         ShAmt = ConstantExpr::getTrunc(ShAmt, A->getType());
831         Value *Shift = Builder.CreateAShr(A, ShAmt, "", IsExact);
832         return CastInst::CreateIntegerCast(Shift, DestTy, true);
833       }
834     }
835     // TODO: Mask high bits with 'and'.
836   }
837 
838   // trunc (*shr (trunc A), C) --> trunc(*shr A, C)
839   if (match(Src, m_OneUse(m_Shr(m_Trunc(m_Value(A)), m_Constant(C))))) {
840     unsigned MaxShiftAmt = SrcWidth - DestWidth;
841 
842     // If the shift is small enough, all zero/sign bits created by the shift are
843     // removed by the trunc.
844     // TODO: Support passing through undef shift amounts - these currently get
845     // zero'd by getIntegerCast.
846     if (match(C, m_SpecificInt_ICMP(ICmpInst::ICMP_ULE,
847                                     APInt(SrcWidth, MaxShiftAmt)))) {
848       auto *OldShift = cast<Instruction>(Src);
849       auto *ShAmt = ConstantExpr::getIntegerCast(C, A->getType(), true);
850       bool IsExact = OldShift->isExact();
851       Value *Shift =
852           OldShift->getOpcode() == Instruction::AShr
853               ? Builder.CreateAShr(A, ShAmt, OldShift->getName(), IsExact)
854               : Builder.CreateLShr(A, ShAmt, OldShift->getName(), IsExact);
855       return CastInst::CreateTruncOrBitCast(Shift, DestTy);
856     }
857   }
858 
859   if (Instruction *I = narrowBinOp(Trunc))
860     return I;
861 
862   if (Instruction *I = shrinkSplatShuffle(Trunc, Builder))
863     return I;
864 
865   if (Instruction *I = shrinkInsertElt(Trunc, Builder))
866     return I;
867 
868   if (Src->hasOneUse() &&
869       (isa<VectorType>(SrcTy) || shouldChangeType(SrcTy, DestTy))) {
870     // Transform "trunc (shl X, cst)" -> "shl (trunc X), cst" so long as the
871     // dest type is native and cst < dest size.
872     if (match(Src, m_Shl(m_Value(A), m_Constant(C))) &&
873         !match(A, m_Shr(m_Value(), m_Constant()))) {
874       // Skip shifts of shift by constants. It undoes a combine in
875       // FoldShiftByConstant and is the extend in reg pattern.
876       APInt Threshold = APInt(C->getType()->getScalarSizeInBits(), DestWidth);
877       if (match(C, m_SpecificInt_ICMP(ICmpInst::ICMP_ULT, Threshold))) {
878         Value *NewTrunc = Builder.CreateTrunc(A, DestTy, A->getName() + ".tr");
879         return BinaryOperator::Create(Instruction::Shl, NewTrunc,
880                                       ConstantExpr::getTrunc(C, DestTy));
881       }
882     }
883   }
884 
885   if (Instruction *I = foldVecTruncToExtElt(Trunc, *this))
886     return I;
887 
888   // Whenever an element is extracted from a vector, and then truncated,
889   // canonicalize by converting it to a bitcast followed by an
890   // extractelement.
891   //
892   // Example (little endian):
893   //   trunc (extractelement <4 x i64> %X, 0) to i32
894   //   --->
895   //   extractelement <8 x i32> (bitcast <4 x i64> %X to <8 x i32>), i32 0
896   Value *VecOp;
897   ConstantInt *Cst;
898   if (match(Src, m_OneUse(m_ExtractElt(m_Value(VecOp), m_ConstantInt(Cst))))) {
899     auto *VecOpTy = cast<FixedVectorType>(VecOp->getType());
900     unsigned VecNumElts = VecOpTy->getNumElements();
901 
902     // A badly fit destination size would result in an invalid cast.
903     if (SrcWidth % DestWidth == 0) {
904       uint64_t TruncRatio = SrcWidth / DestWidth;
905       uint64_t BitCastNumElts = VecNumElts * TruncRatio;
906       uint64_t VecOpIdx = Cst->getZExtValue();
907       uint64_t NewIdx = DL.isBigEndian() ? (VecOpIdx + 1) * TruncRatio - 1
908                                          : VecOpIdx * TruncRatio;
909       assert(BitCastNumElts <= std::numeric_limits<uint32_t>::max() &&
910              "overflow 32-bits");
911 
912       auto *BitCastTo = FixedVectorType::get(DestTy, BitCastNumElts);
913       Value *BitCast = Builder.CreateBitCast(VecOp, BitCastTo);
914       return ExtractElementInst::Create(BitCast, Builder.getInt32(NewIdx));
915     }
916   }
917 
918   return nullptr;
919 }
920 
921 Instruction *InstCombinerImpl::transformZExtICmp(ICmpInst *Cmp, ZExtInst &Zext,
922                                                  bool DoTransform) {
923   // If we are just checking for a icmp eq of a single bit and zext'ing it
924   // to an integer, then shift the bit to the appropriate place and then
925   // cast to integer to avoid the comparison.
926   const APInt *Op1CV;
927   if (match(Cmp->getOperand(1), m_APInt(Op1CV))) {
928 
929     // zext (x <s  0) to i32 --> x>>u31      true if signbit set.
930     // zext (x >s -1) to i32 --> (x>>u31)^1  true if signbit clear.
931     if ((Cmp->getPredicate() == ICmpInst::ICMP_SLT && Op1CV->isNullValue()) ||
932         (Cmp->getPredicate() == ICmpInst::ICMP_SGT && Op1CV->isAllOnesValue())) {
933       if (!DoTransform) return Cmp;
934 
935       Value *In = Cmp->getOperand(0);
936       Value *Sh = ConstantInt::get(In->getType(),
937                                    In->getType()->getScalarSizeInBits() - 1);
938       In = Builder.CreateLShr(In, Sh, In->getName() + ".lobit");
939       if (In->getType() != Zext.getType())
940         In = Builder.CreateIntCast(In, Zext.getType(), false /*ZExt*/);
941 
942       if (Cmp->getPredicate() == ICmpInst::ICMP_SGT) {
943         Constant *One = ConstantInt::get(In->getType(), 1);
944         In = Builder.CreateXor(In, One, In->getName() + ".not");
945       }
946 
947       return replaceInstUsesWith(Zext, In);
948     }
949 
950     // zext (X == 0) to i32 --> X^1      iff X has only the low bit set.
951     // zext (X == 0) to i32 --> (X>>1)^1 iff X has only the 2nd bit set.
952     // zext (X == 1) to i32 --> X        iff X has only the low bit set.
953     // zext (X == 2) to i32 --> X>>1     iff X has only the 2nd bit set.
954     // zext (X != 0) to i32 --> X        iff X has only the low bit set.
955     // zext (X != 0) to i32 --> X>>1     iff X has only the 2nd bit set.
956     // zext (X != 1) to i32 --> X^1      iff X has only the low bit set.
957     // zext (X != 2) to i32 --> (X>>1)^1 iff X has only the 2nd bit set.
958     if ((Op1CV->isNullValue() || Op1CV->isPowerOf2()) &&
959         // This only works for EQ and NE
960         Cmp->isEquality()) {
961       // If Op1C some other power of two, convert:
962       KnownBits Known = computeKnownBits(Cmp->getOperand(0), 0, &Zext);
963 
964       APInt KnownZeroMask(~Known.Zero);
965       if (KnownZeroMask.isPowerOf2()) { // Exactly 1 possible 1?
966         if (!DoTransform) return Cmp;
967 
968         bool isNE = Cmp->getPredicate() == ICmpInst::ICMP_NE;
969         if (!Op1CV->isNullValue() && (*Op1CV != KnownZeroMask)) {
970           // (X&4) == 2 --> false
971           // (X&4) != 2 --> true
972           Constant *Res = ConstantInt::get(Zext.getType(), isNE);
973           return replaceInstUsesWith(Zext, Res);
974         }
975 
976         uint32_t ShAmt = KnownZeroMask.logBase2();
977         Value *In = Cmp->getOperand(0);
978         if (ShAmt) {
979           // Perform a logical shr by shiftamt.
980           // Insert the shift to put the result in the low bit.
981           In = Builder.CreateLShr(In, ConstantInt::get(In->getType(), ShAmt),
982                                   In->getName() + ".lobit");
983         }
984 
985         if (!Op1CV->isNullValue() == isNE) { // Toggle the low bit.
986           Constant *One = ConstantInt::get(In->getType(), 1);
987           In = Builder.CreateXor(In, One);
988         }
989 
990         if (Zext.getType() == In->getType())
991           return replaceInstUsesWith(Zext, In);
992 
993         Value *IntCast = Builder.CreateIntCast(In, Zext.getType(), false);
994         return replaceInstUsesWith(Zext, IntCast);
995       }
996     }
997   }
998 
999   // icmp ne A, B is equal to xor A, B when A and B only really have one bit.
1000   // It is also profitable to transform icmp eq into not(xor(A, B)) because that
1001   // may lead to additional simplifications.
1002   if (Cmp->isEquality() && Zext.getType() == Cmp->getOperand(0)->getType()) {
1003     if (IntegerType *ITy = dyn_cast<IntegerType>(Zext.getType())) {
1004       Value *LHS = Cmp->getOperand(0);
1005       Value *RHS = Cmp->getOperand(1);
1006 
1007       KnownBits KnownLHS = computeKnownBits(LHS, 0, &Zext);
1008       KnownBits KnownRHS = computeKnownBits(RHS, 0, &Zext);
1009 
1010       if (KnownLHS.Zero == KnownRHS.Zero && KnownLHS.One == KnownRHS.One) {
1011         APInt KnownBits = KnownLHS.Zero | KnownLHS.One;
1012         APInt UnknownBit = ~KnownBits;
1013         if (UnknownBit.countPopulation() == 1) {
1014           if (!DoTransform) return Cmp;
1015 
1016           Value *Result = Builder.CreateXor(LHS, RHS);
1017 
1018           // Mask off any bits that are set and won't be shifted away.
1019           if (KnownLHS.One.uge(UnknownBit))
1020             Result = Builder.CreateAnd(Result,
1021                                         ConstantInt::get(ITy, UnknownBit));
1022 
1023           // Shift the bit we're testing down to the lsb.
1024           Result = Builder.CreateLShr(
1025                Result, ConstantInt::get(ITy, UnknownBit.countTrailingZeros()));
1026 
1027           if (Cmp->getPredicate() == ICmpInst::ICMP_EQ)
1028             Result = Builder.CreateXor(Result, ConstantInt::get(ITy, 1));
1029           Result->takeName(Cmp);
1030           return replaceInstUsesWith(Zext, Result);
1031         }
1032       }
1033     }
1034   }
1035 
1036   return nullptr;
1037 }
1038 
1039 /// Determine if the specified value can be computed in the specified wider type
1040 /// and produce the same low bits. If not, return false.
1041 ///
1042 /// If this function returns true, it can also return a non-zero number of bits
1043 /// (in BitsToClear) which indicates that the value it computes is correct for
1044 /// the zero extend, but that the additional BitsToClear bits need to be zero'd
1045 /// out.  For example, to promote something like:
1046 ///
1047 ///   %B = trunc i64 %A to i32
1048 ///   %C = lshr i32 %B, 8
1049 ///   %E = zext i32 %C to i64
1050 ///
1051 /// CanEvaluateZExtd for the 'lshr' will return true, and BitsToClear will be
1052 /// set to 8 to indicate that the promoted value needs to have bits 24-31
1053 /// cleared in addition to bits 32-63.  Since an 'and' will be generated to
1054 /// clear the top bits anyway, doing this has no extra cost.
1055 ///
1056 /// This function works on both vectors and scalars.
1057 static bool canEvaluateZExtd(Value *V, Type *Ty, unsigned &BitsToClear,
1058                              InstCombinerImpl &IC, Instruction *CxtI) {
1059   BitsToClear = 0;
1060   if (canAlwaysEvaluateInType(V, Ty))
1061     return true;
1062   if (canNotEvaluateInType(V, Ty))
1063     return false;
1064 
1065   auto *I = cast<Instruction>(V);
1066   unsigned Tmp;
1067   switch (I->getOpcode()) {
1068   case Instruction::ZExt:  // zext(zext(x)) -> zext(x).
1069   case Instruction::SExt:  // zext(sext(x)) -> sext(x).
1070   case Instruction::Trunc: // zext(trunc(x)) -> trunc(x) or zext(x)
1071     return true;
1072   case Instruction::And:
1073   case Instruction::Or:
1074   case Instruction::Xor:
1075   case Instruction::Add:
1076   case Instruction::Sub:
1077   case Instruction::Mul:
1078     if (!canEvaluateZExtd(I->getOperand(0), Ty, BitsToClear, IC, CxtI) ||
1079         !canEvaluateZExtd(I->getOperand(1), Ty, Tmp, IC, CxtI))
1080       return false;
1081     // These can all be promoted if neither operand has 'bits to clear'.
1082     if (BitsToClear == 0 && Tmp == 0)
1083       return true;
1084 
1085     // If the operation is an AND/OR/XOR and the bits to clear are zero in the
1086     // other side, BitsToClear is ok.
1087     if (Tmp == 0 && I->isBitwiseLogicOp()) {
1088       // We use MaskedValueIsZero here for generality, but the case we care
1089       // about the most is constant RHS.
1090       unsigned VSize = V->getType()->getScalarSizeInBits();
1091       if (IC.MaskedValueIsZero(I->getOperand(1),
1092                                APInt::getHighBitsSet(VSize, BitsToClear),
1093                                0, CxtI)) {
1094         // If this is an And instruction and all of the BitsToClear are
1095         // known to be zero we can reset BitsToClear.
1096         if (I->getOpcode() == Instruction::And)
1097           BitsToClear = 0;
1098         return true;
1099       }
1100     }
1101 
1102     // Otherwise, we don't know how to analyze this BitsToClear case yet.
1103     return false;
1104 
1105   case Instruction::Shl: {
1106     // We can promote shl(x, cst) if we can promote x.  Since shl overwrites the
1107     // upper bits we can reduce BitsToClear by the shift amount.
1108     const APInt *Amt;
1109     if (match(I->getOperand(1), m_APInt(Amt))) {
1110       if (!canEvaluateZExtd(I->getOperand(0), Ty, BitsToClear, IC, CxtI))
1111         return false;
1112       uint64_t ShiftAmt = Amt->getZExtValue();
1113       BitsToClear = ShiftAmt < BitsToClear ? BitsToClear - ShiftAmt : 0;
1114       return true;
1115     }
1116     return false;
1117   }
1118   case Instruction::LShr: {
1119     // We can promote lshr(x, cst) if we can promote x.  This requires the
1120     // ultimate 'and' to clear out the high zero bits we're clearing out though.
1121     const APInt *Amt;
1122     if (match(I->getOperand(1), m_APInt(Amt))) {
1123       if (!canEvaluateZExtd(I->getOperand(0), Ty, BitsToClear, IC, CxtI))
1124         return false;
1125       BitsToClear += Amt->getZExtValue();
1126       if (BitsToClear > V->getType()->getScalarSizeInBits())
1127         BitsToClear = V->getType()->getScalarSizeInBits();
1128       return true;
1129     }
1130     // Cannot promote variable LSHR.
1131     return false;
1132   }
1133   case Instruction::Select:
1134     if (!canEvaluateZExtd(I->getOperand(1), Ty, Tmp, IC, CxtI) ||
1135         !canEvaluateZExtd(I->getOperand(2), Ty, BitsToClear, IC, CxtI) ||
1136         // TODO: If important, we could handle the case when the BitsToClear are
1137         // known zero in the disagreeing side.
1138         Tmp != BitsToClear)
1139       return false;
1140     return true;
1141 
1142   case Instruction::PHI: {
1143     // We can change a phi if we can change all operands.  Note that we never
1144     // get into trouble with cyclic PHIs here because we only consider
1145     // instructions with a single use.
1146     PHINode *PN = cast<PHINode>(I);
1147     if (!canEvaluateZExtd(PN->getIncomingValue(0), Ty, BitsToClear, IC, CxtI))
1148       return false;
1149     for (unsigned i = 1, e = PN->getNumIncomingValues(); i != e; ++i)
1150       if (!canEvaluateZExtd(PN->getIncomingValue(i), Ty, Tmp, IC, CxtI) ||
1151           // TODO: If important, we could handle the case when the BitsToClear
1152           // are known zero in the disagreeing input.
1153           Tmp != BitsToClear)
1154         return false;
1155     return true;
1156   }
1157   default:
1158     // TODO: Can handle more cases here.
1159     return false;
1160   }
1161 }
1162 
1163 Instruction *InstCombinerImpl::visitZExt(ZExtInst &CI) {
1164   // If this zero extend is only used by a truncate, let the truncate be
1165   // eliminated before we try to optimize this zext.
1166   if (CI.hasOneUse() && isa<TruncInst>(CI.user_back()))
1167     return nullptr;
1168 
1169   // If one of the common conversion will work, do it.
1170   if (Instruction *Result = commonCastTransforms(CI))
1171     return Result;
1172 
1173   Value *Src = CI.getOperand(0);
1174   Type *SrcTy = Src->getType(), *DestTy = CI.getType();
1175 
1176   // Try to extend the entire expression tree to the wide destination type.
1177   unsigned BitsToClear;
1178   if (shouldChangeType(SrcTy, DestTy) &&
1179       canEvaluateZExtd(Src, DestTy, BitsToClear, *this, &CI)) {
1180     assert(BitsToClear <= SrcTy->getScalarSizeInBits() &&
1181            "Can't clear more bits than in SrcTy");
1182 
1183     // Okay, we can transform this!  Insert the new expression now.
1184     LLVM_DEBUG(
1185         dbgs() << "ICE: EvaluateInDifferentType converting expression type"
1186                   " to avoid zero extend: "
1187                << CI << '\n');
1188     Value *Res = EvaluateInDifferentType(Src, DestTy, false);
1189     assert(Res->getType() == DestTy);
1190 
1191     // Preserve debug values referring to Src if the zext is its last use.
1192     if (auto *SrcOp = dyn_cast<Instruction>(Src))
1193       if (SrcOp->hasOneUse())
1194         replaceAllDbgUsesWith(*SrcOp, *Res, CI, DT);
1195 
1196     uint32_t SrcBitsKept = SrcTy->getScalarSizeInBits()-BitsToClear;
1197     uint32_t DestBitSize = DestTy->getScalarSizeInBits();
1198 
1199     // If the high bits are already filled with zeros, just replace this
1200     // cast with the result.
1201     if (MaskedValueIsZero(Res,
1202                           APInt::getHighBitsSet(DestBitSize,
1203                                                 DestBitSize-SrcBitsKept),
1204                              0, &CI))
1205       return replaceInstUsesWith(CI, Res);
1206 
1207     // We need to emit an AND to clear the high bits.
1208     Constant *C = ConstantInt::get(Res->getType(),
1209                                APInt::getLowBitsSet(DestBitSize, SrcBitsKept));
1210     return BinaryOperator::CreateAnd(Res, C);
1211   }
1212 
1213   // If this is a TRUNC followed by a ZEXT then we are dealing with integral
1214   // types and if the sizes are just right we can convert this into a logical
1215   // 'and' which will be much cheaper than the pair of casts.
1216   if (TruncInst *CSrc = dyn_cast<TruncInst>(Src)) {   // A->B->C cast
1217     // TODO: Subsume this into EvaluateInDifferentType.
1218 
1219     // Get the sizes of the types involved.  We know that the intermediate type
1220     // will be smaller than A or C, but don't know the relation between A and C.
1221     Value *A = CSrc->getOperand(0);
1222     unsigned SrcSize = A->getType()->getScalarSizeInBits();
1223     unsigned MidSize = CSrc->getType()->getScalarSizeInBits();
1224     unsigned DstSize = CI.getType()->getScalarSizeInBits();
1225     // If we're actually extending zero bits, then if
1226     // SrcSize <  DstSize: zext(a & mask)
1227     // SrcSize == DstSize: a & mask
1228     // SrcSize  > DstSize: trunc(a) & mask
1229     if (SrcSize < DstSize) {
1230       APInt AndValue(APInt::getLowBitsSet(SrcSize, MidSize));
1231       Constant *AndConst = ConstantInt::get(A->getType(), AndValue);
1232       Value *And = Builder.CreateAnd(A, AndConst, CSrc->getName() + ".mask");
1233       return new ZExtInst(And, CI.getType());
1234     }
1235 
1236     if (SrcSize == DstSize) {
1237       APInt AndValue(APInt::getLowBitsSet(SrcSize, MidSize));
1238       return BinaryOperator::CreateAnd(A, ConstantInt::get(A->getType(),
1239                                                            AndValue));
1240     }
1241     if (SrcSize > DstSize) {
1242       Value *Trunc = Builder.CreateTrunc(A, CI.getType());
1243       APInt AndValue(APInt::getLowBitsSet(DstSize, MidSize));
1244       return BinaryOperator::CreateAnd(Trunc,
1245                                        ConstantInt::get(Trunc->getType(),
1246                                                         AndValue));
1247     }
1248   }
1249 
1250   if (ICmpInst *Cmp = dyn_cast<ICmpInst>(Src))
1251     return transformZExtICmp(Cmp, CI);
1252 
1253   BinaryOperator *SrcI = dyn_cast<BinaryOperator>(Src);
1254   if (SrcI && SrcI->getOpcode() == Instruction::Or) {
1255     // zext (or icmp, icmp) -> or (zext icmp), (zext icmp) if at least one
1256     // of the (zext icmp) can be eliminated. If so, immediately perform the
1257     // according elimination.
1258     ICmpInst *LHS = dyn_cast<ICmpInst>(SrcI->getOperand(0));
1259     ICmpInst *RHS = dyn_cast<ICmpInst>(SrcI->getOperand(1));
1260     if (LHS && RHS && LHS->hasOneUse() && RHS->hasOneUse() &&
1261         (transformZExtICmp(LHS, CI, false) ||
1262          transformZExtICmp(RHS, CI, false))) {
1263       // zext (or icmp, icmp) -> or (zext icmp), (zext icmp)
1264       Value *LCast = Builder.CreateZExt(LHS, CI.getType(), LHS->getName());
1265       Value *RCast = Builder.CreateZExt(RHS, CI.getType(), RHS->getName());
1266       Value *Or = Builder.CreateOr(LCast, RCast, CI.getName());
1267       if (auto *OrInst = dyn_cast<Instruction>(Or))
1268         Builder.SetInsertPoint(OrInst);
1269 
1270       // Perform the elimination.
1271       if (auto *LZExt = dyn_cast<ZExtInst>(LCast))
1272         transformZExtICmp(LHS, *LZExt);
1273       if (auto *RZExt = dyn_cast<ZExtInst>(RCast))
1274         transformZExtICmp(RHS, *RZExt);
1275 
1276       return replaceInstUsesWith(CI, Or);
1277     }
1278   }
1279 
1280   // zext(trunc(X) & C) -> (X & zext(C)).
1281   Constant *C;
1282   Value *X;
1283   if (SrcI &&
1284       match(SrcI, m_OneUse(m_And(m_Trunc(m_Value(X)), m_Constant(C)))) &&
1285       X->getType() == CI.getType())
1286     return BinaryOperator::CreateAnd(X, ConstantExpr::getZExt(C, CI.getType()));
1287 
1288   // zext((trunc(X) & C) ^ C) -> ((X & zext(C)) ^ zext(C)).
1289   Value *And;
1290   if (SrcI && match(SrcI, m_OneUse(m_Xor(m_Value(And), m_Constant(C)))) &&
1291       match(And, m_OneUse(m_And(m_Trunc(m_Value(X)), m_Specific(C)))) &&
1292       X->getType() == CI.getType()) {
1293     Constant *ZC = ConstantExpr::getZExt(C, CI.getType());
1294     return BinaryOperator::CreateXor(Builder.CreateAnd(X, ZC), ZC);
1295   }
1296 
1297   return nullptr;
1298 }
1299 
1300 /// Transform (sext icmp) to bitwise / integer operations to eliminate the icmp.
1301 Instruction *InstCombinerImpl::transformSExtICmp(ICmpInst *ICI,
1302                                                  Instruction &CI) {
1303   Value *Op0 = ICI->getOperand(0), *Op1 = ICI->getOperand(1);
1304   ICmpInst::Predicate Pred = ICI->getPredicate();
1305 
1306   // Don't bother if Op1 isn't of vector or integer type.
1307   if (!Op1->getType()->isIntOrIntVectorTy())
1308     return nullptr;
1309 
1310   if ((Pred == ICmpInst::ICMP_SLT && match(Op1, m_ZeroInt())) ||
1311       (Pred == ICmpInst::ICMP_SGT && match(Op1, m_AllOnes()))) {
1312     // (x <s  0) ? -1 : 0 -> ashr x, 31        -> all ones if negative
1313     // (x >s -1) ? -1 : 0 -> not (ashr x, 31)  -> all ones if positive
1314     Value *Sh = ConstantInt::get(Op0->getType(),
1315                                  Op0->getType()->getScalarSizeInBits() - 1);
1316     Value *In = Builder.CreateAShr(Op0, Sh, Op0->getName() + ".lobit");
1317     if (In->getType() != CI.getType())
1318       In = Builder.CreateIntCast(In, CI.getType(), true /*SExt*/);
1319 
1320     if (Pred == ICmpInst::ICMP_SGT)
1321       In = Builder.CreateNot(In, In->getName() + ".not");
1322     return replaceInstUsesWith(CI, In);
1323   }
1324 
1325   if (ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
1326     // If we know that only one bit of the LHS of the icmp can be set and we
1327     // have an equality comparison with zero or a power of 2, we can transform
1328     // the icmp and sext into bitwise/integer operations.
1329     if (ICI->hasOneUse() &&
1330         ICI->isEquality() && (Op1C->isZero() || Op1C->getValue().isPowerOf2())){
1331       KnownBits Known = computeKnownBits(Op0, 0, &CI);
1332 
1333       APInt KnownZeroMask(~Known.Zero);
1334       if (KnownZeroMask.isPowerOf2()) {
1335         Value *In = ICI->getOperand(0);
1336 
1337         // If the icmp tests for a known zero bit we can constant fold it.
1338         if (!Op1C->isZero() && Op1C->getValue() != KnownZeroMask) {
1339           Value *V = Pred == ICmpInst::ICMP_NE ?
1340                        ConstantInt::getAllOnesValue(CI.getType()) :
1341                        ConstantInt::getNullValue(CI.getType());
1342           return replaceInstUsesWith(CI, V);
1343         }
1344 
1345         if (!Op1C->isZero() == (Pred == ICmpInst::ICMP_NE)) {
1346           // sext ((x & 2^n) == 0)   -> (x >> n) - 1
1347           // sext ((x & 2^n) != 2^n) -> (x >> n) - 1
1348           unsigned ShiftAmt = KnownZeroMask.countTrailingZeros();
1349           // Perform a right shift to place the desired bit in the LSB.
1350           if (ShiftAmt)
1351             In = Builder.CreateLShr(In,
1352                                     ConstantInt::get(In->getType(), ShiftAmt));
1353 
1354           // At this point "In" is either 1 or 0. Subtract 1 to turn
1355           // {1, 0} -> {0, -1}.
1356           In = Builder.CreateAdd(In,
1357                                  ConstantInt::getAllOnesValue(In->getType()),
1358                                  "sext");
1359         } else {
1360           // sext ((x & 2^n) != 0)   -> (x << bitwidth-n) a>> bitwidth-1
1361           // sext ((x & 2^n) == 2^n) -> (x << bitwidth-n) a>> bitwidth-1
1362           unsigned ShiftAmt = KnownZeroMask.countLeadingZeros();
1363           // Perform a left shift to place the desired bit in the MSB.
1364           if (ShiftAmt)
1365             In = Builder.CreateShl(In,
1366                                    ConstantInt::get(In->getType(), ShiftAmt));
1367 
1368           // Distribute the bit over the whole bit width.
1369           In = Builder.CreateAShr(In, ConstantInt::get(In->getType(),
1370                                   KnownZeroMask.getBitWidth() - 1), "sext");
1371         }
1372 
1373         if (CI.getType() == In->getType())
1374           return replaceInstUsesWith(CI, In);
1375         return CastInst::CreateIntegerCast(In, CI.getType(), true/*SExt*/);
1376       }
1377     }
1378   }
1379 
1380   return nullptr;
1381 }
1382 
1383 /// Return true if we can take the specified value and return it as type Ty
1384 /// without inserting any new casts and without changing the value of the common
1385 /// low bits.  This is used by code that tries to promote integer operations to
1386 /// a wider types will allow us to eliminate the extension.
1387 ///
1388 /// This function works on both vectors and scalars.
1389 ///
1390 static bool canEvaluateSExtd(Value *V, Type *Ty) {
1391   assert(V->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits() &&
1392          "Can't sign extend type to a smaller type");
1393   if (canAlwaysEvaluateInType(V, Ty))
1394     return true;
1395   if (canNotEvaluateInType(V, Ty))
1396     return false;
1397 
1398   auto *I = cast<Instruction>(V);
1399   switch (I->getOpcode()) {
1400   case Instruction::SExt:  // sext(sext(x)) -> sext(x)
1401   case Instruction::ZExt:  // sext(zext(x)) -> zext(x)
1402   case Instruction::Trunc: // sext(trunc(x)) -> trunc(x) or sext(x)
1403     return true;
1404   case Instruction::And:
1405   case Instruction::Or:
1406   case Instruction::Xor:
1407   case Instruction::Add:
1408   case Instruction::Sub:
1409   case Instruction::Mul:
1410     // These operators can all arbitrarily be extended if their inputs can.
1411     return canEvaluateSExtd(I->getOperand(0), Ty) &&
1412            canEvaluateSExtd(I->getOperand(1), Ty);
1413 
1414   //case Instruction::Shl:   TODO
1415   //case Instruction::LShr:  TODO
1416 
1417   case Instruction::Select:
1418     return canEvaluateSExtd(I->getOperand(1), Ty) &&
1419            canEvaluateSExtd(I->getOperand(2), Ty);
1420 
1421   case Instruction::PHI: {
1422     // We can change a phi if we can change all operands.  Note that we never
1423     // get into trouble with cyclic PHIs here because we only consider
1424     // instructions with a single use.
1425     PHINode *PN = cast<PHINode>(I);
1426     for (Value *IncValue : PN->incoming_values())
1427       if (!canEvaluateSExtd(IncValue, Ty)) return false;
1428     return true;
1429   }
1430   default:
1431     // TODO: Can handle more cases here.
1432     break;
1433   }
1434 
1435   return false;
1436 }
1437 
1438 Instruction *InstCombinerImpl::visitSExt(SExtInst &CI) {
1439   // If this sign extend is only used by a truncate, let the truncate be
1440   // eliminated before we try to optimize this sext.
1441   if (CI.hasOneUse() && isa<TruncInst>(CI.user_back()))
1442     return nullptr;
1443 
1444   if (Instruction *I = commonCastTransforms(CI))
1445     return I;
1446 
1447   Value *Src = CI.getOperand(0);
1448   Type *SrcTy = Src->getType(), *DestTy = CI.getType();
1449 
1450   // If we know that the value being extended is positive, we can use a zext
1451   // instead.
1452   KnownBits Known = computeKnownBits(Src, 0, &CI);
1453   if (Known.isNonNegative())
1454     return CastInst::Create(Instruction::ZExt, Src, DestTy);
1455 
1456   // Try to extend the entire expression tree to the wide destination type.
1457   if (shouldChangeType(SrcTy, DestTy) && canEvaluateSExtd(Src, DestTy)) {
1458     // Okay, we can transform this!  Insert the new expression now.
1459     LLVM_DEBUG(
1460         dbgs() << "ICE: EvaluateInDifferentType converting expression type"
1461                   " to avoid sign extend: "
1462                << CI << '\n');
1463     Value *Res = EvaluateInDifferentType(Src, DestTy, true);
1464     assert(Res->getType() == DestTy);
1465 
1466     uint32_t SrcBitSize = SrcTy->getScalarSizeInBits();
1467     uint32_t DestBitSize = DestTy->getScalarSizeInBits();
1468 
1469     // If the high bits are already filled with sign bit, just replace this
1470     // cast with the result.
1471     if (ComputeNumSignBits(Res, 0, &CI) > DestBitSize - SrcBitSize)
1472       return replaceInstUsesWith(CI, Res);
1473 
1474     // We need to emit a shl + ashr to do the sign extend.
1475     Value *ShAmt = ConstantInt::get(DestTy, DestBitSize-SrcBitSize);
1476     return BinaryOperator::CreateAShr(Builder.CreateShl(Res, ShAmt, "sext"),
1477                                       ShAmt);
1478   }
1479 
1480   // If the input is a trunc from the destination type, then turn sext(trunc(x))
1481   // into shifts.
1482   Value *X;
1483   if (match(Src, m_OneUse(m_Trunc(m_Value(X)))) && X->getType() == DestTy) {
1484     // sext(trunc(X)) --> ashr(shl(X, C), C)
1485     unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1486     unsigned DestBitSize = DestTy->getScalarSizeInBits();
1487     Constant *ShAmt = ConstantInt::get(DestTy, DestBitSize - SrcBitSize);
1488     return BinaryOperator::CreateAShr(Builder.CreateShl(X, ShAmt), ShAmt);
1489   }
1490 
1491   if (ICmpInst *ICI = dyn_cast<ICmpInst>(Src))
1492     return transformSExtICmp(ICI, CI);
1493 
1494   // If the input is a shl/ashr pair of a same constant, then this is a sign
1495   // extension from a smaller value.  If we could trust arbitrary bitwidth
1496   // integers, we could turn this into a truncate to the smaller bit and then
1497   // use a sext for the whole extension.  Since we don't, look deeper and check
1498   // for a truncate.  If the source and dest are the same type, eliminate the
1499   // trunc and extend and just do shifts.  For example, turn:
1500   //   %a = trunc i32 %i to i8
1501   //   %b = shl i8 %a, 6
1502   //   %c = ashr i8 %b, 6
1503   //   %d = sext i8 %c to i32
1504   // into:
1505   //   %a = shl i32 %i, 30
1506   //   %d = ashr i32 %a, 30
1507   Value *A = nullptr;
1508   // TODO: Eventually this could be subsumed by EvaluateInDifferentType.
1509   Constant *BA = nullptr, *CA = nullptr;
1510   if (match(Src, m_AShr(m_Shl(m_Trunc(m_Value(A)), m_Constant(BA)),
1511                         m_Constant(CA))) &&
1512       BA == CA && A->getType() == CI.getType()) {
1513     unsigned MidSize = Src->getType()->getScalarSizeInBits();
1514     unsigned SrcDstSize = CI.getType()->getScalarSizeInBits();
1515     Constant *SizeDiff = ConstantInt::get(CA->getType(), SrcDstSize - MidSize);
1516     Constant *ShAmt = ConstantExpr::getAdd(CA, SizeDiff);
1517     Constant *ShAmtExt = ConstantExpr::getSExt(ShAmt, CI.getType());
1518     A = Builder.CreateShl(A, ShAmtExt, CI.getName());
1519     return BinaryOperator::CreateAShr(A, ShAmtExt);
1520   }
1521 
1522   return nullptr;
1523 }
1524 
1525 /// Return a Constant* for the specified floating-point constant if it fits
1526 /// in the specified FP type without changing its value.
1527 static bool fitsInFPType(ConstantFP *CFP, const fltSemantics &Sem) {
1528   bool losesInfo;
1529   APFloat F = CFP->getValueAPF();
1530   (void)F.convert(Sem, APFloat::rmNearestTiesToEven, &losesInfo);
1531   return !losesInfo;
1532 }
1533 
1534 static Type *shrinkFPConstant(ConstantFP *CFP) {
1535   if (CFP->getType() == Type::getPPC_FP128Ty(CFP->getContext()))
1536     return nullptr;  // No constant folding of this.
1537   // See if the value can be truncated to half and then reextended.
1538   if (fitsInFPType(CFP, APFloat::IEEEhalf()))
1539     return Type::getHalfTy(CFP->getContext());
1540   // See if the value can be truncated to float and then reextended.
1541   if (fitsInFPType(CFP, APFloat::IEEEsingle()))
1542     return Type::getFloatTy(CFP->getContext());
1543   if (CFP->getType()->isDoubleTy())
1544     return nullptr;  // Won't shrink.
1545   if (fitsInFPType(CFP, APFloat::IEEEdouble()))
1546     return Type::getDoubleTy(CFP->getContext());
1547   // Don't try to shrink to various long double types.
1548   return nullptr;
1549 }
1550 
1551 // Determine if this is a vector of ConstantFPs and if so, return the minimal
1552 // type we can safely truncate all elements to.
1553 // TODO: Make these support undef elements.
1554 static Type *shrinkFPConstantVector(Value *V) {
1555   auto *CV = dyn_cast<Constant>(V);
1556   auto *CVVTy = dyn_cast<VectorType>(V->getType());
1557   if (!CV || !CVVTy)
1558     return nullptr;
1559 
1560   Type *MinType = nullptr;
1561 
1562   unsigned NumElts = cast<FixedVectorType>(CVVTy)->getNumElements();
1563   for (unsigned i = 0; i != NumElts; ++i) {
1564     auto *CFP = dyn_cast_or_null<ConstantFP>(CV->getAggregateElement(i));
1565     if (!CFP)
1566       return nullptr;
1567 
1568     Type *T = shrinkFPConstant(CFP);
1569     if (!T)
1570       return nullptr;
1571 
1572     // If we haven't found a type yet or this type has a larger mantissa than
1573     // our previous type, this is our new minimal type.
1574     if (!MinType || T->getFPMantissaWidth() > MinType->getFPMantissaWidth())
1575       MinType = T;
1576   }
1577 
1578   // Make a vector type from the minimal type.
1579   return FixedVectorType::get(MinType, NumElts);
1580 }
1581 
1582 /// Find the minimum FP type we can safely truncate to.
1583 static Type *getMinimumFPType(Value *V) {
1584   if (auto *FPExt = dyn_cast<FPExtInst>(V))
1585     return FPExt->getOperand(0)->getType();
1586 
1587   // If this value is a constant, return the constant in the smallest FP type
1588   // that can accurately represent it.  This allows us to turn
1589   // (float)((double)X+2.0) into x+2.0f.
1590   if (auto *CFP = dyn_cast<ConstantFP>(V))
1591     if (Type *T = shrinkFPConstant(CFP))
1592       return T;
1593 
1594   // Try to shrink a vector of FP constants.
1595   if (Type *T = shrinkFPConstantVector(V))
1596     return T;
1597 
1598   return V->getType();
1599 }
1600 
1601 /// Return true if the cast from integer to FP can be proven to be exact for all
1602 /// possible inputs (the conversion does not lose any precision).
1603 static bool isKnownExactCastIntToFP(CastInst &I) {
1604   CastInst::CastOps Opcode = I.getOpcode();
1605   assert((Opcode == CastInst::SIToFP || Opcode == CastInst::UIToFP) &&
1606          "Unexpected cast");
1607   Value *Src = I.getOperand(0);
1608   Type *SrcTy = Src->getType();
1609   Type *FPTy = I.getType();
1610   bool IsSigned = Opcode == Instruction::SIToFP;
1611   int SrcSize = (int)SrcTy->getScalarSizeInBits() - IsSigned;
1612 
1613   // Easy case - if the source integer type has less bits than the FP mantissa,
1614   // then the cast must be exact.
1615   int DestNumSigBits = FPTy->getFPMantissaWidth();
1616   if (SrcSize <= DestNumSigBits)
1617     return true;
1618 
1619   // Cast from FP to integer and back to FP is independent of the intermediate
1620   // integer width because of poison on overflow.
1621   Value *F;
1622   if (match(Src, m_FPToSI(m_Value(F))) || match(Src, m_FPToUI(m_Value(F)))) {
1623     // If this is uitofp (fptosi F), the source needs an extra bit to avoid
1624     // potential rounding of negative FP input values.
1625     int SrcNumSigBits = F->getType()->getFPMantissaWidth();
1626     if (!IsSigned && match(Src, m_FPToSI(m_Value())))
1627       SrcNumSigBits++;
1628 
1629     // [su]itofp (fpto[su]i F) --> exact if the source type has less or equal
1630     // significant bits than the destination (and make sure neither type is
1631     // weird -- ppc_fp128).
1632     if (SrcNumSigBits > 0 && DestNumSigBits > 0 &&
1633         SrcNumSigBits <= DestNumSigBits)
1634       return true;
1635   }
1636 
1637   // TODO:
1638   // Try harder to find if the source integer type has less significant bits.
1639   // For example, compute number of sign bits or compute low bit mask.
1640   return false;
1641 }
1642 
1643 Instruction *InstCombinerImpl::visitFPTrunc(FPTruncInst &FPT) {
1644   if (Instruction *I = commonCastTransforms(FPT))
1645     return I;
1646 
1647   // If we have fptrunc(OpI (fpextend x), (fpextend y)), we would like to
1648   // simplify this expression to avoid one or more of the trunc/extend
1649   // operations if we can do so without changing the numerical results.
1650   //
1651   // The exact manner in which the widths of the operands interact to limit
1652   // what we can and cannot do safely varies from operation to operation, and
1653   // is explained below in the various case statements.
1654   Type *Ty = FPT.getType();
1655   auto *BO = dyn_cast<BinaryOperator>(FPT.getOperand(0));
1656   if (BO && BO->hasOneUse()) {
1657     Type *LHSMinType = getMinimumFPType(BO->getOperand(0));
1658     Type *RHSMinType = getMinimumFPType(BO->getOperand(1));
1659     unsigned OpWidth = BO->getType()->getFPMantissaWidth();
1660     unsigned LHSWidth = LHSMinType->getFPMantissaWidth();
1661     unsigned RHSWidth = RHSMinType->getFPMantissaWidth();
1662     unsigned SrcWidth = std::max(LHSWidth, RHSWidth);
1663     unsigned DstWidth = Ty->getFPMantissaWidth();
1664     switch (BO->getOpcode()) {
1665       default: break;
1666       case Instruction::FAdd:
1667       case Instruction::FSub:
1668         // For addition and subtraction, the infinitely precise result can
1669         // essentially be arbitrarily wide; proving that double rounding
1670         // will not occur because the result of OpI is exact (as we will for
1671         // FMul, for example) is hopeless.  However, we *can* nonetheless
1672         // frequently know that double rounding cannot occur (or that it is
1673         // innocuous) by taking advantage of the specific structure of
1674         // infinitely-precise results that admit double rounding.
1675         //
1676         // Specifically, if OpWidth >= 2*DstWdith+1 and DstWidth is sufficient
1677         // to represent both sources, we can guarantee that the double
1678         // rounding is innocuous (See p50 of Figueroa's 2000 PhD thesis,
1679         // "A Rigorous Framework for Fully Supporting the IEEE Standard ..."
1680         // for proof of this fact).
1681         //
1682         // Note: Figueroa does not consider the case where DstFormat !=
1683         // SrcFormat.  It's possible (likely even!) that this analysis
1684         // could be tightened for those cases, but they are rare (the main
1685         // case of interest here is (float)((double)float + float)).
1686         if (OpWidth >= 2*DstWidth+1 && DstWidth >= SrcWidth) {
1687           Value *LHS = Builder.CreateFPTrunc(BO->getOperand(0), Ty);
1688           Value *RHS = Builder.CreateFPTrunc(BO->getOperand(1), Ty);
1689           Instruction *RI = BinaryOperator::Create(BO->getOpcode(), LHS, RHS);
1690           RI->copyFastMathFlags(BO);
1691           return RI;
1692         }
1693         break;
1694       case Instruction::FMul:
1695         // For multiplication, the infinitely precise result has at most
1696         // LHSWidth + RHSWidth significant bits; if OpWidth is sufficient
1697         // that such a value can be exactly represented, then no double
1698         // rounding can possibly occur; we can safely perform the operation
1699         // in the destination format if it can represent both sources.
1700         if (OpWidth >= LHSWidth + RHSWidth && DstWidth >= SrcWidth) {
1701           Value *LHS = Builder.CreateFPTrunc(BO->getOperand(0), Ty);
1702           Value *RHS = Builder.CreateFPTrunc(BO->getOperand(1), Ty);
1703           return BinaryOperator::CreateFMulFMF(LHS, RHS, BO);
1704         }
1705         break;
1706       case Instruction::FDiv:
1707         // For division, we use again use the bound from Figueroa's
1708         // dissertation.  I am entirely certain that this bound can be
1709         // tightened in the unbalanced operand case by an analysis based on
1710         // the diophantine rational approximation bound, but the well-known
1711         // condition used here is a good conservative first pass.
1712         // TODO: Tighten bound via rigorous analysis of the unbalanced case.
1713         if (OpWidth >= 2*DstWidth && DstWidth >= SrcWidth) {
1714           Value *LHS = Builder.CreateFPTrunc(BO->getOperand(0), Ty);
1715           Value *RHS = Builder.CreateFPTrunc(BO->getOperand(1), Ty);
1716           return BinaryOperator::CreateFDivFMF(LHS, RHS, BO);
1717         }
1718         break;
1719       case Instruction::FRem: {
1720         // Remainder is straightforward.  Remainder is always exact, so the
1721         // type of OpI doesn't enter into things at all.  We simply evaluate
1722         // in whichever source type is larger, then convert to the
1723         // destination type.
1724         if (SrcWidth == OpWidth)
1725           break;
1726         Value *LHS, *RHS;
1727         if (LHSWidth == SrcWidth) {
1728            LHS = Builder.CreateFPTrunc(BO->getOperand(0), LHSMinType);
1729            RHS = Builder.CreateFPTrunc(BO->getOperand(1), LHSMinType);
1730         } else {
1731            LHS = Builder.CreateFPTrunc(BO->getOperand(0), RHSMinType);
1732            RHS = Builder.CreateFPTrunc(BO->getOperand(1), RHSMinType);
1733         }
1734 
1735         Value *ExactResult = Builder.CreateFRemFMF(LHS, RHS, BO);
1736         return CastInst::CreateFPCast(ExactResult, Ty);
1737       }
1738     }
1739   }
1740 
1741   // (fptrunc (fneg x)) -> (fneg (fptrunc x))
1742   Value *X;
1743   Instruction *Op = dyn_cast<Instruction>(FPT.getOperand(0));
1744   if (Op && Op->hasOneUse()) {
1745     // FIXME: The FMF should propagate from the fptrunc, not the source op.
1746     IRBuilder<>::FastMathFlagGuard FMFG(Builder);
1747     if (isa<FPMathOperator>(Op))
1748       Builder.setFastMathFlags(Op->getFastMathFlags());
1749 
1750     if (match(Op, m_FNeg(m_Value(X)))) {
1751       Value *InnerTrunc = Builder.CreateFPTrunc(X, Ty);
1752 
1753       return UnaryOperator::CreateFNegFMF(InnerTrunc, Op);
1754     }
1755 
1756     // If we are truncating a select that has an extended operand, we can
1757     // narrow the other operand and do the select as a narrow op.
1758     Value *Cond, *X, *Y;
1759     if (match(Op, m_Select(m_Value(Cond), m_FPExt(m_Value(X)), m_Value(Y))) &&
1760         X->getType() == Ty) {
1761       // fptrunc (select Cond, (fpext X), Y --> select Cond, X, (fptrunc Y)
1762       Value *NarrowY = Builder.CreateFPTrunc(Y, Ty);
1763       Value *Sel = Builder.CreateSelect(Cond, X, NarrowY, "narrow.sel", Op);
1764       return replaceInstUsesWith(FPT, Sel);
1765     }
1766     if (match(Op, m_Select(m_Value(Cond), m_Value(Y), m_FPExt(m_Value(X)))) &&
1767         X->getType() == Ty) {
1768       // fptrunc (select Cond, Y, (fpext X) --> select Cond, (fptrunc Y), X
1769       Value *NarrowY = Builder.CreateFPTrunc(Y, Ty);
1770       Value *Sel = Builder.CreateSelect(Cond, NarrowY, X, "narrow.sel", Op);
1771       return replaceInstUsesWith(FPT, Sel);
1772     }
1773   }
1774 
1775   if (auto *II = dyn_cast<IntrinsicInst>(FPT.getOperand(0))) {
1776     switch (II->getIntrinsicID()) {
1777     default: break;
1778     case Intrinsic::ceil:
1779     case Intrinsic::fabs:
1780     case Intrinsic::floor:
1781     case Intrinsic::nearbyint:
1782     case Intrinsic::rint:
1783     case Intrinsic::round:
1784     case Intrinsic::roundeven:
1785     case Intrinsic::trunc: {
1786       Value *Src = II->getArgOperand(0);
1787       if (!Src->hasOneUse())
1788         break;
1789 
1790       // Except for fabs, this transformation requires the input of the unary FP
1791       // operation to be itself an fpext from the type to which we're
1792       // truncating.
1793       if (II->getIntrinsicID() != Intrinsic::fabs) {
1794         FPExtInst *FPExtSrc = dyn_cast<FPExtInst>(Src);
1795         if (!FPExtSrc || FPExtSrc->getSrcTy() != Ty)
1796           break;
1797       }
1798 
1799       // Do unary FP operation on smaller type.
1800       // (fptrunc (fabs x)) -> (fabs (fptrunc x))
1801       Value *InnerTrunc = Builder.CreateFPTrunc(Src, Ty);
1802       Function *Overload = Intrinsic::getDeclaration(FPT.getModule(),
1803                                                      II->getIntrinsicID(), Ty);
1804       SmallVector<OperandBundleDef, 1> OpBundles;
1805       II->getOperandBundlesAsDefs(OpBundles);
1806       CallInst *NewCI =
1807           CallInst::Create(Overload, {InnerTrunc}, OpBundles, II->getName());
1808       NewCI->copyFastMathFlags(II);
1809       return NewCI;
1810     }
1811     }
1812   }
1813 
1814   if (Instruction *I = shrinkInsertElt(FPT, Builder))
1815     return I;
1816 
1817   Value *Src = FPT.getOperand(0);
1818   if (isa<SIToFPInst>(Src) || isa<UIToFPInst>(Src)) {
1819     auto *FPCast = cast<CastInst>(Src);
1820     if (isKnownExactCastIntToFP(*FPCast))
1821       return CastInst::Create(FPCast->getOpcode(), FPCast->getOperand(0), Ty);
1822   }
1823 
1824   return nullptr;
1825 }
1826 
1827 Instruction *InstCombinerImpl::visitFPExt(CastInst &FPExt) {
1828   // If the source operand is a cast from integer to FP and known exact, then
1829   // cast the integer operand directly to the destination type.
1830   Type *Ty = FPExt.getType();
1831   Value *Src = FPExt.getOperand(0);
1832   if (isa<SIToFPInst>(Src) || isa<UIToFPInst>(Src)) {
1833     auto *FPCast = cast<CastInst>(Src);
1834     if (isKnownExactCastIntToFP(*FPCast))
1835       return CastInst::Create(FPCast->getOpcode(), FPCast->getOperand(0), Ty);
1836   }
1837 
1838   return commonCastTransforms(FPExt);
1839 }
1840 
1841 /// fpto{s/u}i({u/s}itofp(X)) --> X or zext(X) or sext(X) or trunc(X)
1842 /// This is safe if the intermediate type has enough bits in its mantissa to
1843 /// accurately represent all values of X.  For example, this won't work with
1844 /// i64 -> float -> i64.
1845 Instruction *InstCombinerImpl::foldItoFPtoI(CastInst &FI) {
1846   if (!isa<UIToFPInst>(FI.getOperand(0)) && !isa<SIToFPInst>(FI.getOperand(0)))
1847     return nullptr;
1848 
1849   auto *OpI = cast<CastInst>(FI.getOperand(0));
1850   Value *X = OpI->getOperand(0);
1851   Type *XType = X->getType();
1852   Type *DestType = FI.getType();
1853   bool IsOutputSigned = isa<FPToSIInst>(FI);
1854 
1855   // Since we can assume the conversion won't overflow, our decision as to
1856   // whether the input will fit in the float should depend on the minimum
1857   // of the input range and output range.
1858 
1859   // This means this is also safe for a signed input and unsigned output, since
1860   // a negative input would lead to undefined behavior.
1861   if (!isKnownExactCastIntToFP(*OpI)) {
1862     // The first cast may not round exactly based on the source integer width
1863     // and FP width, but the overflow UB rules can still allow this to fold.
1864     // If the destination type is narrow, that means the intermediate FP value
1865     // must be large enough to hold the source value exactly.
1866     // For example, (uint8_t)((float)(uint32_t 16777217) is undefined behavior.
1867     int OutputSize = (int)DestType->getScalarSizeInBits() - IsOutputSigned;
1868     if (OutputSize > OpI->getType()->getFPMantissaWidth())
1869       return nullptr;
1870   }
1871 
1872   if (DestType->getScalarSizeInBits() > XType->getScalarSizeInBits()) {
1873     bool IsInputSigned = isa<SIToFPInst>(OpI);
1874     if (IsInputSigned && IsOutputSigned)
1875       return new SExtInst(X, DestType);
1876     return new ZExtInst(X, DestType);
1877   }
1878   if (DestType->getScalarSizeInBits() < XType->getScalarSizeInBits())
1879     return new TruncInst(X, DestType);
1880 
1881   assert(XType == DestType && "Unexpected types for int to FP to int casts");
1882   return replaceInstUsesWith(FI, X);
1883 }
1884 
1885 Instruction *InstCombinerImpl::visitFPToUI(FPToUIInst &FI) {
1886   if (Instruction *I = foldItoFPtoI(FI))
1887     return I;
1888 
1889   return commonCastTransforms(FI);
1890 }
1891 
1892 Instruction *InstCombinerImpl::visitFPToSI(FPToSIInst &FI) {
1893   if (Instruction *I = foldItoFPtoI(FI))
1894     return I;
1895 
1896   return commonCastTransforms(FI);
1897 }
1898 
1899 Instruction *InstCombinerImpl::visitUIToFP(CastInst &CI) {
1900   return commonCastTransforms(CI);
1901 }
1902 
1903 Instruction *InstCombinerImpl::visitSIToFP(CastInst &CI) {
1904   return commonCastTransforms(CI);
1905 }
1906 
1907 Instruction *InstCombinerImpl::visitIntToPtr(IntToPtrInst &CI) {
1908   // If the source integer type is not the intptr_t type for this target, do a
1909   // trunc or zext to the intptr_t type, then inttoptr of it.  This allows the
1910   // cast to be exposed to other transforms.
1911   unsigned AS = CI.getAddressSpace();
1912   if (CI.getOperand(0)->getType()->getScalarSizeInBits() !=
1913       DL.getPointerSizeInBits(AS)) {
1914     Type *Ty = DL.getIntPtrType(CI.getContext(), AS);
1915     // Handle vectors of pointers.
1916     if (auto *CIVTy = dyn_cast<VectorType>(CI.getType()))
1917       Ty = VectorType::get(Ty, CIVTy->getElementCount());
1918 
1919     Value *P = Builder.CreateZExtOrTrunc(CI.getOperand(0), Ty);
1920     return new IntToPtrInst(P, CI.getType());
1921   }
1922 
1923   if (Instruction *I = commonCastTransforms(CI))
1924     return I;
1925 
1926   return nullptr;
1927 }
1928 
1929 /// Implement the transforms for cast of pointer (bitcast/ptrtoint)
1930 Instruction *InstCombinerImpl::commonPointerCastTransforms(CastInst &CI) {
1931   Value *Src = CI.getOperand(0);
1932 
1933   if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Src)) {
1934     // If casting the result of a getelementptr instruction with no offset, turn
1935     // this into a cast of the original pointer!
1936     if (GEP->hasAllZeroIndices() &&
1937         // If CI is an addrspacecast and GEP changes the poiner type, merging
1938         // GEP into CI would undo canonicalizing addrspacecast with different
1939         // pointer types, causing infinite loops.
1940         (!isa<AddrSpaceCastInst>(CI) ||
1941          GEP->getType() == GEP->getPointerOperandType())) {
1942       // Changing the cast operand is usually not a good idea but it is safe
1943       // here because the pointer operand is being replaced with another
1944       // pointer operand so the opcode doesn't need to change.
1945       return replaceOperand(CI, 0, GEP->getOperand(0));
1946     }
1947   }
1948 
1949   return commonCastTransforms(CI);
1950 }
1951 
1952 Instruction *InstCombinerImpl::visitPtrToInt(PtrToIntInst &CI) {
1953   // If the destination integer type is not the intptr_t type for this target,
1954   // do a ptrtoint to intptr_t then do a trunc or zext.  This allows the cast
1955   // to be exposed to other transforms.
1956   Value *SrcOp = CI.getPointerOperand();
1957   Type *Ty = CI.getType();
1958   unsigned AS = CI.getPointerAddressSpace();
1959   unsigned TySize = Ty->getScalarSizeInBits();
1960   unsigned PtrSize = DL.getPointerSizeInBits(AS);
1961   if (TySize != PtrSize) {
1962     Type *IntPtrTy = DL.getIntPtrType(CI.getContext(), AS);
1963     if (auto *VecTy = dyn_cast<VectorType>(Ty)) {
1964       // Handle vectors of pointers.
1965       // FIXME: what should happen for scalable vectors?
1966       IntPtrTy = FixedVectorType::get(
1967           IntPtrTy, cast<FixedVectorType>(VecTy)->getNumElements());
1968     }
1969 
1970     Value *P = Builder.CreatePtrToInt(SrcOp, IntPtrTy);
1971     return CastInst::CreateIntegerCast(P, Ty, /*isSigned=*/false);
1972   }
1973 
1974   Value *Vec, *Scalar, *Index;
1975   if (match(SrcOp, m_OneUse(m_InsertElt(m_IntToPtr(m_Value(Vec)),
1976                                         m_Value(Scalar), m_Value(Index)))) &&
1977       Vec->getType() == Ty) {
1978     assert(Vec->getType()->getScalarSizeInBits() == PtrSize && "Wrong type");
1979     // Convert the scalar to int followed by insert to eliminate one cast:
1980     // p2i (ins (i2p Vec), Scalar, Index --> ins Vec, (p2i Scalar), Index
1981     Value *NewCast = Builder.CreatePtrToInt(Scalar, Ty->getScalarType());
1982     return InsertElementInst::Create(Vec, NewCast, Index);
1983   }
1984 
1985   return commonPointerCastTransforms(CI);
1986 }
1987 
1988 /// This input value (which is known to have vector type) is being zero extended
1989 /// or truncated to the specified vector type. Since the zext/trunc is done
1990 /// using an integer type, we have a (bitcast(cast(bitcast))) pattern,
1991 /// endianness will impact which end of the vector that is extended or
1992 /// truncated.
1993 ///
1994 /// A vector is always stored with index 0 at the lowest address, which
1995 /// corresponds to the most significant bits for a big endian stored integer and
1996 /// the least significant bits for little endian. A trunc/zext of an integer
1997 /// impacts the big end of the integer. Thus, we need to add/remove elements at
1998 /// the front of the vector for big endian targets, and the back of the vector
1999 /// for little endian targets.
2000 ///
2001 /// Try to replace it with a shuffle (and vector/vector bitcast) if possible.
2002 ///
2003 /// The source and destination vector types may have different element types.
2004 static Instruction *
2005 optimizeVectorResizeWithIntegerBitCasts(Value *InVal, VectorType *DestTy,
2006                                         InstCombinerImpl &IC) {
2007   // We can only do this optimization if the output is a multiple of the input
2008   // element size, or the input is a multiple of the output element size.
2009   // Convert the input type to have the same element type as the output.
2010   VectorType *SrcTy = cast<VectorType>(InVal->getType());
2011 
2012   if (SrcTy->getElementType() != DestTy->getElementType()) {
2013     // The input types don't need to be identical, but for now they must be the
2014     // same size.  There is no specific reason we couldn't handle things like
2015     // <4 x i16> -> <4 x i32> by bitcasting to <2 x i32> but haven't gotten
2016     // there yet.
2017     if (SrcTy->getElementType()->getPrimitiveSizeInBits() !=
2018         DestTy->getElementType()->getPrimitiveSizeInBits())
2019       return nullptr;
2020 
2021     SrcTy =
2022         FixedVectorType::get(DestTy->getElementType(),
2023                              cast<FixedVectorType>(SrcTy)->getNumElements());
2024     InVal = IC.Builder.CreateBitCast(InVal, SrcTy);
2025   }
2026 
2027   bool IsBigEndian = IC.getDataLayout().isBigEndian();
2028   unsigned SrcElts = cast<FixedVectorType>(SrcTy)->getNumElements();
2029   unsigned DestElts = cast<FixedVectorType>(DestTy)->getNumElements();
2030 
2031   assert(SrcElts != DestElts && "Element counts should be different.");
2032 
2033   // Now that the element types match, get the shuffle mask and RHS of the
2034   // shuffle to use, which depends on whether we're increasing or decreasing the
2035   // size of the input.
2036   SmallVector<int, 16> ShuffleMaskStorage;
2037   ArrayRef<int> ShuffleMask;
2038   Value *V2;
2039 
2040   // Produce an identify shuffle mask for the src vector.
2041   ShuffleMaskStorage.resize(SrcElts);
2042   std::iota(ShuffleMaskStorage.begin(), ShuffleMaskStorage.end(), 0);
2043 
2044   if (SrcElts > DestElts) {
2045     // If we're shrinking the number of elements (rewriting an integer
2046     // truncate), just shuffle in the elements corresponding to the least
2047     // significant bits from the input and use undef as the second shuffle
2048     // input.
2049     V2 = UndefValue::get(SrcTy);
2050     // Make sure the shuffle mask selects the "least significant bits" by
2051     // keeping elements from back of the src vector for big endian, and from the
2052     // front for little endian.
2053     ShuffleMask = ShuffleMaskStorage;
2054     if (IsBigEndian)
2055       ShuffleMask = ShuffleMask.take_back(DestElts);
2056     else
2057       ShuffleMask = ShuffleMask.take_front(DestElts);
2058   } else {
2059     // If we're increasing the number of elements (rewriting an integer zext),
2060     // shuffle in all of the elements from InVal. Fill the rest of the result
2061     // elements with zeros from a constant zero.
2062     V2 = Constant::getNullValue(SrcTy);
2063     // Use first elt from V2 when indicating zero in the shuffle mask.
2064     uint32_t NullElt = SrcElts;
2065     // Extend with null values in the "most significant bits" by adding elements
2066     // in front of the src vector for big endian, and at the back for little
2067     // endian.
2068     unsigned DeltaElts = DestElts - SrcElts;
2069     if (IsBigEndian)
2070       ShuffleMaskStorage.insert(ShuffleMaskStorage.begin(), DeltaElts, NullElt);
2071     else
2072       ShuffleMaskStorage.append(DeltaElts, NullElt);
2073     ShuffleMask = ShuffleMaskStorage;
2074   }
2075 
2076   return new ShuffleVectorInst(InVal, V2, ShuffleMask);
2077 }
2078 
2079 static bool isMultipleOfTypeSize(unsigned Value, Type *Ty) {
2080   return Value % Ty->getPrimitiveSizeInBits() == 0;
2081 }
2082 
2083 static unsigned getTypeSizeIndex(unsigned Value, Type *Ty) {
2084   return Value / Ty->getPrimitiveSizeInBits();
2085 }
2086 
2087 /// V is a value which is inserted into a vector of VecEltTy.
2088 /// Look through the value to see if we can decompose it into
2089 /// insertions into the vector.  See the example in the comment for
2090 /// OptimizeIntegerToVectorInsertions for the pattern this handles.
2091 /// The type of V is always a non-zero multiple of VecEltTy's size.
2092 /// Shift is the number of bits between the lsb of V and the lsb of
2093 /// the vector.
2094 ///
2095 /// This returns false if the pattern can't be matched or true if it can,
2096 /// filling in Elements with the elements found here.
2097 static bool collectInsertionElements(Value *V, unsigned Shift,
2098                                      SmallVectorImpl<Value *> &Elements,
2099                                      Type *VecEltTy, bool isBigEndian) {
2100   assert(isMultipleOfTypeSize(Shift, VecEltTy) &&
2101          "Shift should be a multiple of the element type size");
2102 
2103   // Undef values never contribute useful bits to the result.
2104   if (isa<UndefValue>(V)) return true;
2105 
2106   // If we got down to a value of the right type, we win, try inserting into the
2107   // right element.
2108   if (V->getType() == VecEltTy) {
2109     // Inserting null doesn't actually insert any elements.
2110     if (Constant *C = dyn_cast<Constant>(V))
2111       if (C->isNullValue())
2112         return true;
2113 
2114     unsigned ElementIndex = getTypeSizeIndex(Shift, VecEltTy);
2115     if (isBigEndian)
2116       ElementIndex = Elements.size() - ElementIndex - 1;
2117 
2118     // Fail if multiple elements are inserted into this slot.
2119     if (Elements[ElementIndex])
2120       return false;
2121 
2122     Elements[ElementIndex] = V;
2123     return true;
2124   }
2125 
2126   if (Constant *C = dyn_cast<Constant>(V)) {
2127     // Figure out the # elements this provides, and bitcast it or slice it up
2128     // as required.
2129     unsigned NumElts = getTypeSizeIndex(C->getType()->getPrimitiveSizeInBits(),
2130                                         VecEltTy);
2131     // If the constant is the size of a vector element, we just need to bitcast
2132     // it to the right type so it gets properly inserted.
2133     if (NumElts == 1)
2134       return collectInsertionElements(ConstantExpr::getBitCast(C, VecEltTy),
2135                                       Shift, Elements, VecEltTy, isBigEndian);
2136 
2137     // Okay, this is a constant that covers multiple elements.  Slice it up into
2138     // pieces and insert each element-sized piece into the vector.
2139     if (!isa<IntegerType>(C->getType()))
2140       C = ConstantExpr::getBitCast(C, IntegerType::get(V->getContext(),
2141                                        C->getType()->getPrimitiveSizeInBits()));
2142     unsigned ElementSize = VecEltTy->getPrimitiveSizeInBits();
2143     Type *ElementIntTy = IntegerType::get(C->getContext(), ElementSize);
2144 
2145     for (unsigned i = 0; i != NumElts; ++i) {
2146       unsigned ShiftI = Shift+i*ElementSize;
2147       Constant *Piece = ConstantExpr::getLShr(C, ConstantInt::get(C->getType(),
2148                                                                   ShiftI));
2149       Piece = ConstantExpr::getTrunc(Piece, ElementIntTy);
2150       if (!collectInsertionElements(Piece, ShiftI, Elements, VecEltTy,
2151                                     isBigEndian))
2152         return false;
2153     }
2154     return true;
2155   }
2156 
2157   if (!V->hasOneUse()) return false;
2158 
2159   Instruction *I = dyn_cast<Instruction>(V);
2160   if (!I) return false;
2161   switch (I->getOpcode()) {
2162   default: return false; // Unhandled case.
2163   case Instruction::BitCast:
2164     return collectInsertionElements(I->getOperand(0), Shift, Elements, VecEltTy,
2165                                     isBigEndian);
2166   case Instruction::ZExt:
2167     if (!isMultipleOfTypeSize(
2168                           I->getOperand(0)->getType()->getPrimitiveSizeInBits(),
2169                               VecEltTy))
2170       return false;
2171     return collectInsertionElements(I->getOperand(0), Shift, Elements, VecEltTy,
2172                                     isBigEndian);
2173   case Instruction::Or:
2174     return collectInsertionElements(I->getOperand(0), Shift, Elements, VecEltTy,
2175                                     isBigEndian) &&
2176            collectInsertionElements(I->getOperand(1), Shift, Elements, VecEltTy,
2177                                     isBigEndian);
2178   case Instruction::Shl: {
2179     // Must be shifting by a constant that is a multiple of the element size.
2180     ConstantInt *CI = dyn_cast<ConstantInt>(I->getOperand(1));
2181     if (!CI) return false;
2182     Shift += CI->getZExtValue();
2183     if (!isMultipleOfTypeSize(Shift, VecEltTy)) return false;
2184     return collectInsertionElements(I->getOperand(0), Shift, Elements, VecEltTy,
2185                                     isBigEndian);
2186   }
2187 
2188   }
2189 }
2190 
2191 
2192 /// If the input is an 'or' instruction, we may be doing shifts and ors to
2193 /// assemble the elements of the vector manually.
2194 /// Try to rip the code out and replace it with insertelements.  This is to
2195 /// optimize code like this:
2196 ///
2197 ///    %tmp37 = bitcast float %inc to i32
2198 ///    %tmp38 = zext i32 %tmp37 to i64
2199 ///    %tmp31 = bitcast float %inc5 to i32
2200 ///    %tmp32 = zext i32 %tmp31 to i64
2201 ///    %tmp33 = shl i64 %tmp32, 32
2202 ///    %ins35 = or i64 %tmp33, %tmp38
2203 ///    %tmp43 = bitcast i64 %ins35 to <2 x float>
2204 ///
2205 /// Into two insertelements that do "buildvector{%inc, %inc5}".
2206 static Value *optimizeIntegerToVectorInsertions(BitCastInst &CI,
2207                                                 InstCombinerImpl &IC) {
2208   auto *DestVecTy = cast<FixedVectorType>(CI.getType());
2209   Value *IntInput = CI.getOperand(0);
2210 
2211   SmallVector<Value*, 8> Elements(DestVecTy->getNumElements());
2212   if (!collectInsertionElements(IntInput, 0, Elements,
2213                                 DestVecTy->getElementType(),
2214                                 IC.getDataLayout().isBigEndian()))
2215     return nullptr;
2216 
2217   // If we succeeded, we know that all of the element are specified by Elements
2218   // or are zero if Elements has a null entry.  Recast this as a set of
2219   // insertions.
2220   Value *Result = Constant::getNullValue(CI.getType());
2221   for (unsigned i = 0, e = Elements.size(); i != e; ++i) {
2222     if (!Elements[i]) continue;  // Unset element.
2223 
2224     Result = IC.Builder.CreateInsertElement(Result, Elements[i],
2225                                             IC.Builder.getInt32(i));
2226   }
2227 
2228   return Result;
2229 }
2230 
2231 /// Canonicalize scalar bitcasts of extracted elements into a bitcast of the
2232 /// vector followed by extract element. The backend tends to handle bitcasts of
2233 /// vectors better than bitcasts of scalars because vector registers are
2234 /// usually not type-specific like scalar integer or scalar floating-point.
2235 static Instruction *canonicalizeBitCastExtElt(BitCastInst &BitCast,
2236                                               InstCombinerImpl &IC) {
2237   // TODO: Create and use a pattern matcher for ExtractElementInst.
2238   auto *ExtElt = dyn_cast<ExtractElementInst>(BitCast.getOperand(0));
2239   if (!ExtElt || !ExtElt->hasOneUse())
2240     return nullptr;
2241 
2242   // The bitcast must be to a vectorizable type, otherwise we can't make a new
2243   // type to extract from.
2244   Type *DestType = BitCast.getType();
2245   if (!VectorType::isValidElementType(DestType))
2246     return nullptr;
2247 
2248   auto *NewVecType = VectorType::get(DestType, ExtElt->getVectorOperandType());
2249   auto *NewBC = IC.Builder.CreateBitCast(ExtElt->getVectorOperand(),
2250                                          NewVecType, "bc");
2251   return ExtractElementInst::Create(NewBC, ExtElt->getIndexOperand());
2252 }
2253 
2254 /// Change the type of a bitwise logic operation if we can eliminate a bitcast.
2255 static Instruction *foldBitCastBitwiseLogic(BitCastInst &BitCast,
2256                                             InstCombiner::BuilderTy &Builder) {
2257   Type *DestTy = BitCast.getType();
2258   BinaryOperator *BO;
2259   if (!DestTy->isIntOrIntVectorTy() ||
2260       !match(BitCast.getOperand(0), m_OneUse(m_BinOp(BO))) ||
2261       !BO->isBitwiseLogicOp())
2262     return nullptr;
2263 
2264   // FIXME: This transform is restricted to vector types to avoid backend
2265   // problems caused by creating potentially illegal operations. If a fix-up is
2266   // added to handle that situation, we can remove this check.
2267   if (!DestTy->isVectorTy() || !BO->getType()->isVectorTy())
2268     return nullptr;
2269 
2270   Value *X;
2271   if (match(BO->getOperand(0), m_OneUse(m_BitCast(m_Value(X)))) &&
2272       X->getType() == DestTy && !isa<Constant>(X)) {
2273     // bitcast(logic(bitcast(X), Y)) --> logic'(X, bitcast(Y))
2274     Value *CastedOp1 = Builder.CreateBitCast(BO->getOperand(1), DestTy);
2275     return BinaryOperator::Create(BO->getOpcode(), X, CastedOp1);
2276   }
2277 
2278   if (match(BO->getOperand(1), m_OneUse(m_BitCast(m_Value(X)))) &&
2279       X->getType() == DestTy && !isa<Constant>(X)) {
2280     // bitcast(logic(Y, bitcast(X))) --> logic'(bitcast(Y), X)
2281     Value *CastedOp0 = Builder.CreateBitCast(BO->getOperand(0), DestTy);
2282     return BinaryOperator::Create(BO->getOpcode(), CastedOp0, X);
2283   }
2284 
2285   // Canonicalize vector bitcasts to come before vector bitwise logic with a
2286   // constant. This eases recognition of special constants for later ops.
2287   // Example:
2288   // icmp u/s (a ^ signmask), (b ^ signmask) --> icmp s/u a, b
2289   Constant *C;
2290   if (match(BO->getOperand(1), m_Constant(C))) {
2291     // bitcast (logic X, C) --> logic (bitcast X, C')
2292     Value *CastedOp0 = Builder.CreateBitCast(BO->getOperand(0), DestTy);
2293     Value *CastedC = Builder.CreateBitCast(C, DestTy);
2294     return BinaryOperator::Create(BO->getOpcode(), CastedOp0, CastedC);
2295   }
2296 
2297   return nullptr;
2298 }
2299 
2300 /// Change the type of a select if we can eliminate a bitcast.
2301 static Instruction *foldBitCastSelect(BitCastInst &BitCast,
2302                                       InstCombiner::BuilderTy &Builder) {
2303   Value *Cond, *TVal, *FVal;
2304   if (!match(BitCast.getOperand(0),
2305              m_OneUse(m_Select(m_Value(Cond), m_Value(TVal), m_Value(FVal)))))
2306     return nullptr;
2307 
2308   // A vector select must maintain the same number of elements in its operands.
2309   Type *CondTy = Cond->getType();
2310   Type *DestTy = BitCast.getType();
2311   if (auto *CondVTy = dyn_cast<VectorType>(CondTy)) {
2312     if (!DestTy->isVectorTy())
2313       return nullptr;
2314     if (cast<FixedVectorType>(DestTy)->getNumElements() !=
2315         cast<FixedVectorType>(CondVTy)->getNumElements())
2316       return nullptr;
2317   }
2318 
2319   // FIXME: This transform is restricted from changing the select between
2320   // scalars and vectors to avoid backend problems caused by creating
2321   // potentially illegal operations. If a fix-up is added to handle that
2322   // situation, we can remove this check.
2323   if (DestTy->isVectorTy() != TVal->getType()->isVectorTy())
2324     return nullptr;
2325 
2326   auto *Sel = cast<Instruction>(BitCast.getOperand(0));
2327   Value *X;
2328   if (match(TVal, m_OneUse(m_BitCast(m_Value(X)))) && X->getType() == DestTy &&
2329       !isa<Constant>(X)) {
2330     // bitcast(select(Cond, bitcast(X), Y)) --> select'(Cond, X, bitcast(Y))
2331     Value *CastedVal = Builder.CreateBitCast(FVal, DestTy);
2332     return SelectInst::Create(Cond, X, CastedVal, "", nullptr, Sel);
2333   }
2334 
2335   if (match(FVal, m_OneUse(m_BitCast(m_Value(X)))) && X->getType() == DestTy &&
2336       !isa<Constant>(X)) {
2337     // bitcast(select(Cond, Y, bitcast(X))) --> select'(Cond, bitcast(Y), X)
2338     Value *CastedVal = Builder.CreateBitCast(TVal, DestTy);
2339     return SelectInst::Create(Cond, CastedVal, X, "", nullptr, Sel);
2340   }
2341 
2342   return nullptr;
2343 }
2344 
2345 /// Check if all users of CI are StoreInsts.
2346 static bool hasStoreUsersOnly(CastInst &CI) {
2347   for (User *U : CI.users()) {
2348     if (!isa<StoreInst>(U))
2349       return false;
2350   }
2351   return true;
2352 }
2353 
2354 /// This function handles following case
2355 ///
2356 ///     A  ->  B    cast
2357 ///     PHI
2358 ///     B  ->  A    cast
2359 ///
2360 /// All the related PHI nodes can be replaced by new PHI nodes with type A.
2361 /// The uses of \p CI can be changed to the new PHI node corresponding to \p PN.
2362 Instruction *InstCombinerImpl::optimizeBitCastFromPhi(CastInst &CI,
2363                                                       PHINode *PN) {
2364   // BitCast used by Store can be handled in InstCombineLoadStoreAlloca.cpp.
2365   if (hasStoreUsersOnly(CI))
2366     return nullptr;
2367 
2368   Value *Src = CI.getOperand(0);
2369   Type *SrcTy = Src->getType();         // Type B
2370   Type *DestTy = CI.getType();          // Type A
2371 
2372   SmallVector<PHINode *, 4> PhiWorklist;
2373   SmallSetVector<PHINode *, 4> OldPhiNodes;
2374 
2375   // Find all of the A->B casts and PHI nodes.
2376   // We need to inspect all related PHI nodes, but PHIs can be cyclic, so
2377   // OldPhiNodes is used to track all known PHI nodes, before adding a new
2378   // PHI to PhiWorklist, it is checked against and added to OldPhiNodes first.
2379   PhiWorklist.push_back(PN);
2380   OldPhiNodes.insert(PN);
2381   while (!PhiWorklist.empty()) {
2382     auto *OldPN = PhiWorklist.pop_back_val();
2383     for (Value *IncValue : OldPN->incoming_values()) {
2384       if (isa<Constant>(IncValue))
2385         continue;
2386 
2387       if (auto *LI = dyn_cast<LoadInst>(IncValue)) {
2388         // If there is a sequence of one or more load instructions, each loaded
2389         // value is used as address of later load instruction, bitcast is
2390         // necessary to change the value type, don't optimize it. For
2391         // simplicity we give up if the load address comes from another load.
2392         Value *Addr = LI->getOperand(0);
2393         if (Addr == &CI || isa<LoadInst>(Addr))
2394           return nullptr;
2395         if (LI->hasOneUse() && LI->isSimple())
2396           continue;
2397         // If a LoadInst has more than one use, changing the type of loaded
2398         // value may create another bitcast.
2399         return nullptr;
2400       }
2401 
2402       if (auto *PNode = dyn_cast<PHINode>(IncValue)) {
2403         if (OldPhiNodes.insert(PNode))
2404           PhiWorklist.push_back(PNode);
2405         continue;
2406       }
2407 
2408       auto *BCI = dyn_cast<BitCastInst>(IncValue);
2409       // We can't handle other instructions.
2410       if (!BCI)
2411         return nullptr;
2412 
2413       // Verify it's a A->B cast.
2414       Type *TyA = BCI->getOperand(0)->getType();
2415       Type *TyB = BCI->getType();
2416       if (TyA != DestTy || TyB != SrcTy)
2417         return nullptr;
2418     }
2419   }
2420 
2421   // Check that each user of each old PHI node is something that we can
2422   // rewrite, so that all of the old PHI nodes can be cleaned up afterwards.
2423   for (auto *OldPN : OldPhiNodes) {
2424     for (User *V : OldPN->users()) {
2425       if (auto *SI = dyn_cast<StoreInst>(V)) {
2426         if (!SI->isSimple() || SI->getOperand(0) != OldPN)
2427           return nullptr;
2428       } else if (auto *BCI = dyn_cast<BitCastInst>(V)) {
2429         // Verify it's a B->A cast.
2430         Type *TyB = BCI->getOperand(0)->getType();
2431         Type *TyA = BCI->getType();
2432         if (TyA != DestTy || TyB != SrcTy)
2433           return nullptr;
2434       } else if (auto *PHI = dyn_cast<PHINode>(V)) {
2435         // As long as the user is another old PHI node, then even if we don't
2436         // rewrite it, the PHI web we're considering won't have any users
2437         // outside itself, so it'll be dead.
2438         if (OldPhiNodes.count(PHI) == 0)
2439           return nullptr;
2440       } else {
2441         return nullptr;
2442       }
2443     }
2444   }
2445 
2446   // For each old PHI node, create a corresponding new PHI node with a type A.
2447   SmallDenseMap<PHINode *, PHINode *> NewPNodes;
2448   for (auto *OldPN : OldPhiNodes) {
2449     Builder.SetInsertPoint(OldPN);
2450     PHINode *NewPN = Builder.CreatePHI(DestTy, OldPN->getNumOperands());
2451     NewPNodes[OldPN] = NewPN;
2452   }
2453 
2454   // Fill in the operands of new PHI nodes.
2455   for (auto *OldPN : OldPhiNodes) {
2456     PHINode *NewPN = NewPNodes[OldPN];
2457     for (unsigned j = 0, e = OldPN->getNumOperands(); j != e; ++j) {
2458       Value *V = OldPN->getOperand(j);
2459       Value *NewV = nullptr;
2460       if (auto *C = dyn_cast<Constant>(V)) {
2461         NewV = ConstantExpr::getBitCast(C, DestTy);
2462       } else if (auto *LI = dyn_cast<LoadInst>(V)) {
2463         // Explicitly perform load combine to make sure no opposing transform
2464         // can remove the bitcast in the meantime and trigger an infinite loop.
2465         Builder.SetInsertPoint(LI);
2466         NewV = combineLoadToNewType(*LI, DestTy);
2467         // Remove the old load and its use in the old phi, which itself becomes
2468         // dead once the whole transform finishes.
2469         replaceInstUsesWith(*LI, UndefValue::get(LI->getType()));
2470         eraseInstFromFunction(*LI);
2471       } else if (auto *BCI = dyn_cast<BitCastInst>(V)) {
2472         NewV = BCI->getOperand(0);
2473       } else if (auto *PrevPN = dyn_cast<PHINode>(V)) {
2474         NewV = NewPNodes[PrevPN];
2475       }
2476       assert(NewV);
2477       NewPN->addIncoming(NewV, OldPN->getIncomingBlock(j));
2478     }
2479   }
2480 
2481   // Traverse all accumulated PHI nodes and process its users,
2482   // which are Stores and BitcCasts. Without this processing
2483   // NewPHI nodes could be replicated and could lead to extra
2484   // moves generated after DeSSA.
2485   // If there is a store with type B, change it to type A.
2486 
2487 
2488   // Replace users of BitCast B->A with NewPHI. These will help
2489   // later to get rid off a closure formed by OldPHI nodes.
2490   Instruction *RetVal = nullptr;
2491   for (auto *OldPN : OldPhiNodes) {
2492     PHINode *NewPN = NewPNodes[OldPN];
2493     for (auto It = OldPN->user_begin(), End = OldPN->user_end(); It != End; ) {
2494       User *V = *It;
2495       // We may remove this user, advance to avoid iterator invalidation.
2496       ++It;
2497       if (auto *SI = dyn_cast<StoreInst>(V)) {
2498         assert(SI->isSimple() && SI->getOperand(0) == OldPN);
2499         Builder.SetInsertPoint(SI);
2500         auto *NewBC =
2501           cast<BitCastInst>(Builder.CreateBitCast(NewPN, SrcTy));
2502         SI->setOperand(0, NewBC);
2503         Worklist.push(SI);
2504         assert(hasStoreUsersOnly(*NewBC));
2505       }
2506       else if (auto *BCI = dyn_cast<BitCastInst>(V)) {
2507         Type *TyB = BCI->getOperand(0)->getType();
2508         Type *TyA = BCI->getType();
2509         assert(TyA == DestTy && TyB == SrcTy);
2510         (void) TyA;
2511         (void) TyB;
2512         Instruction *I = replaceInstUsesWith(*BCI, NewPN);
2513         if (BCI == &CI)
2514           RetVal = I;
2515       } else if (auto *PHI = dyn_cast<PHINode>(V)) {
2516         assert(OldPhiNodes.count(PHI) > 0);
2517         (void) PHI;
2518       } else {
2519         llvm_unreachable("all uses should be handled");
2520       }
2521     }
2522   }
2523 
2524   return RetVal;
2525 }
2526 
2527 Instruction *InstCombinerImpl::visitBitCast(BitCastInst &CI) {
2528   // If the operands are integer typed then apply the integer transforms,
2529   // otherwise just apply the common ones.
2530   Value *Src = CI.getOperand(0);
2531   Type *SrcTy = Src->getType();
2532   Type *DestTy = CI.getType();
2533 
2534   // Get rid of casts from one type to the same type. These are useless and can
2535   // be replaced by the operand.
2536   if (DestTy == Src->getType())
2537     return replaceInstUsesWith(CI, Src);
2538 
2539   if (isa<PointerType>(SrcTy) && isa<PointerType>(DestTy)) {
2540     PointerType *SrcPTy = cast<PointerType>(SrcTy);
2541     PointerType *DstPTy = cast<PointerType>(DestTy);
2542     Type *DstElTy = DstPTy->getElementType();
2543     Type *SrcElTy = SrcPTy->getElementType();
2544 
2545     // Casting pointers between the same type, but with different address spaces
2546     // is an addrspace cast rather than a bitcast.
2547     if ((DstElTy == SrcElTy) &&
2548         (DstPTy->getAddressSpace() != SrcPTy->getAddressSpace()))
2549       return new AddrSpaceCastInst(Src, DestTy);
2550 
2551     // If we are casting a alloca to a pointer to a type of the same
2552     // size, rewrite the allocation instruction to allocate the "right" type.
2553     // There is no need to modify malloc calls because it is their bitcast that
2554     // needs to be cleaned up.
2555     if (AllocaInst *AI = dyn_cast<AllocaInst>(Src))
2556       if (Instruction *V = PromoteCastOfAllocation(CI, *AI))
2557         return V;
2558 
2559     // When the type pointed to is not sized the cast cannot be
2560     // turned into a gep.
2561     Type *PointeeType =
2562         cast<PointerType>(Src->getType()->getScalarType())->getElementType();
2563     if (!PointeeType->isSized())
2564       return nullptr;
2565 
2566     // If the source and destination are pointers, and this cast is equivalent
2567     // to a getelementptr X, 0, 0, 0...  turn it into the appropriate gep.
2568     // This can enhance SROA and other transforms that want type-safe pointers.
2569     unsigned NumZeros = 0;
2570     while (SrcElTy && SrcElTy != DstElTy) {
2571       SrcElTy = GetElementPtrInst::getTypeAtIndex(SrcElTy, (uint64_t)0);
2572       ++NumZeros;
2573     }
2574 
2575     // If we found a path from the src to dest, create the getelementptr now.
2576     if (SrcElTy == DstElTy) {
2577       SmallVector<Value *, 8> Idxs(NumZeros + 1, Builder.getInt32(0));
2578       GetElementPtrInst *GEP =
2579           GetElementPtrInst::Create(SrcPTy->getElementType(), Src, Idxs);
2580 
2581       // If the source pointer is dereferenceable, then assume it points to an
2582       // allocated object and apply "inbounds" to the GEP.
2583       bool CanBeNull;
2584       if (Src->getPointerDereferenceableBytes(DL, CanBeNull)) {
2585         // In a non-default address space (not 0), a null pointer can not be
2586         // assumed inbounds, so ignore that case (dereferenceable_or_null).
2587         // The reason is that 'null' is not treated differently in these address
2588         // spaces, and we consequently ignore the 'gep inbounds' special case
2589         // for 'null' which allows 'inbounds' on 'null' if the indices are
2590         // zeros.
2591         if (SrcPTy->getAddressSpace() == 0 || !CanBeNull)
2592           GEP->setIsInBounds();
2593       }
2594       return GEP;
2595     }
2596   }
2597 
2598   if (FixedVectorType *DestVTy = dyn_cast<FixedVectorType>(DestTy)) {
2599     // Beware: messing with this target-specific oddity may cause trouble.
2600     if (DestVTy->getNumElements() == 1 && SrcTy->isX86_MMXTy()) {
2601       Value *Elem = Builder.CreateBitCast(Src, DestVTy->getElementType());
2602       return InsertElementInst::Create(UndefValue::get(DestTy), Elem,
2603                      Constant::getNullValue(Type::getInt32Ty(CI.getContext())));
2604     }
2605 
2606     if (isa<IntegerType>(SrcTy)) {
2607       // If this is a cast from an integer to vector, check to see if the input
2608       // is a trunc or zext of a bitcast from vector.  If so, we can replace all
2609       // the casts with a shuffle and (potentially) a bitcast.
2610       if (isa<TruncInst>(Src) || isa<ZExtInst>(Src)) {
2611         CastInst *SrcCast = cast<CastInst>(Src);
2612         if (BitCastInst *BCIn = dyn_cast<BitCastInst>(SrcCast->getOperand(0)))
2613           if (isa<VectorType>(BCIn->getOperand(0)->getType()))
2614             if (Instruction *I = optimizeVectorResizeWithIntegerBitCasts(
2615                     BCIn->getOperand(0), cast<VectorType>(DestTy), *this))
2616               return I;
2617       }
2618 
2619       // If the input is an 'or' instruction, we may be doing shifts and ors to
2620       // assemble the elements of the vector manually.  Try to rip the code out
2621       // and replace it with insertelements.
2622       if (Value *V = optimizeIntegerToVectorInsertions(CI, *this))
2623         return replaceInstUsesWith(CI, V);
2624     }
2625   }
2626 
2627   if (FixedVectorType *SrcVTy = dyn_cast<FixedVectorType>(SrcTy)) {
2628     if (SrcVTy->getNumElements() == 1) {
2629       // If our destination is not a vector, then make this a straight
2630       // scalar-scalar cast.
2631       if (!DestTy->isVectorTy()) {
2632         Value *Elem =
2633           Builder.CreateExtractElement(Src,
2634                      Constant::getNullValue(Type::getInt32Ty(CI.getContext())));
2635         return CastInst::Create(Instruction::BitCast, Elem, DestTy);
2636       }
2637 
2638       // Otherwise, see if our source is an insert. If so, then use the scalar
2639       // component directly:
2640       // bitcast (inselt <1 x elt> V, X, 0) to <n x m> --> bitcast X to <n x m>
2641       if (auto *InsElt = dyn_cast<InsertElementInst>(Src))
2642         return new BitCastInst(InsElt->getOperand(1), DestTy);
2643     }
2644   }
2645 
2646   if (auto *Shuf = dyn_cast<ShuffleVectorInst>(Src)) {
2647     // Okay, we have (bitcast (shuffle ..)).  Check to see if this is
2648     // a bitcast to a vector with the same # elts.
2649     Value *ShufOp0 = Shuf->getOperand(0);
2650     Value *ShufOp1 = Shuf->getOperand(1);
2651     unsigned NumShufElts =
2652         cast<FixedVectorType>(Shuf->getType())->getNumElements();
2653     unsigned NumSrcVecElts =
2654         cast<FixedVectorType>(ShufOp0->getType())->getNumElements();
2655     if (Shuf->hasOneUse() && DestTy->isVectorTy() &&
2656         cast<FixedVectorType>(DestTy)->getNumElements() == NumShufElts &&
2657         NumShufElts == NumSrcVecElts) {
2658       BitCastInst *Tmp;
2659       // If either of the operands is a cast from CI.getType(), then
2660       // evaluating the shuffle in the casted destination's type will allow
2661       // us to eliminate at least one cast.
2662       if (((Tmp = dyn_cast<BitCastInst>(ShufOp0)) &&
2663            Tmp->getOperand(0)->getType() == DestTy) ||
2664           ((Tmp = dyn_cast<BitCastInst>(ShufOp1)) &&
2665            Tmp->getOperand(0)->getType() == DestTy)) {
2666         Value *LHS = Builder.CreateBitCast(ShufOp0, DestTy);
2667         Value *RHS = Builder.CreateBitCast(ShufOp1, DestTy);
2668         // Return a new shuffle vector.  Use the same element ID's, as we
2669         // know the vector types match #elts.
2670         return new ShuffleVectorInst(LHS, RHS, Shuf->getShuffleMask());
2671       }
2672     }
2673 
2674     // A bitcasted-to-scalar and byte-reversing shuffle is better recognized as
2675     // a byte-swap:
2676     // bitcast <N x i8> (shuf X, undef, <N, N-1,...0>) --> bswap (bitcast X)
2677     // TODO: We should match the related pattern for bitreverse.
2678     if (DestTy->isIntegerTy() &&
2679         DL.isLegalInteger(DestTy->getScalarSizeInBits()) &&
2680         SrcTy->getScalarSizeInBits() == 8 && NumShufElts % 2 == 0 &&
2681         Shuf->hasOneUse() && Shuf->isReverse()) {
2682       assert(ShufOp0->getType() == SrcTy && "Unexpected shuffle mask");
2683       assert(isa<UndefValue>(ShufOp1) && "Unexpected shuffle op");
2684       Function *Bswap =
2685           Intrinsic::getDeclaration(CI.getModule(), Intrinsic::bswap, DestTy);
2686       Value *ScalarX = Builder.CreateBitCast(ShufOp0, DestTy);
2687       return IntrinsicInst::Create(Bswap, { ScalarX });
2688     }
2689   }
2690 
2691   // Handle the A->B->A cast, and there is an intervening PHI node.
2692   if (PHINode *PN = dyn_cast<PHINode>(Src))
2693     if (Instruction *I = optimizeBitCastFromPhi(CI, PN))
2694       return I;
2695 
2696   if (Instruction *I = canonicalizeBitCastExtElt(CI, *this))
2697     return I;
2698 
2699   if (Instruction *I = foldBitCastBitwiseLogic(CI, Builder))
2700     return I;
2701 
2702   if (Instruction *I = foldBitCastSelect(CI, Builder))
2703     return I;
2704 
2705   if (SrcTy->isPointerTy())
2706     return commonPointerCastTransforms(CI);
2707   return commonCastTransforms(CI);
2708 }
2709 
2710 Instruction *InstCombinerImpl::visitAddrSpaceCast(AddrSpaceCastInst &CI) {
2711   // If the destination pointer element type is not the same as the source's
2712   // first do a bitcast to the destination type, and then the addrspacecast.
2713   // This allows the cast to be exposed to other transforms.
2714   Value *Src = CI.getOperand(0);
2715   PointerType *SrcTy = cast<PointerType>(Src->getType()->getScalarType());
2716   PointerType *DestTy = cast<PointerType>(CI.getType()->getScalarType());
2717 
2718   Type *DestElemTy = DestTy->getElementType();
2719   if (SrcTy->getElementType() != DestElemTy) {
2720     Type *MidTy = PointerType::get(DestElemTy, SrcTy->getAddressSpace());
2721     if (VectorType *VT = dyn_cast<VectorType>(CI.getType())) {
2722       // Handle vectors of pointers.
2723       // FIXME: what should happen for scalable vectors?
2724       MidTy = FixedVectorType::get(MidTy,
2725                                    cast<FixedVectorType>(VT)->getNumElements());
2726     }
2727 
2728     Value *NewBitCast = Builder.CreateBitCast(Src, MidTy);
2729     return new AddrSpaceCastInst(NewBitCast, CI.getType());
2730   }
2731 
2732   return commonPointerCastTransforms(CI);
2733 }
2734