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   ConstantInt *Cst;
718 
719   // Attempt to truncate the entire input expression tree to the destination
720   // type.   Only do this if the dest type is a simple type, don't convert the
721   // expression tree to something weird like i93 unless the source is also
722   // strange.
723   if ((DestTy->isVectorTy() || shouldChangeType(SrcTy, DestTy)) &&
724       canEvaluateTruncated(Src, DestTy, *this, &Trunc)) {
725 
726     // If this cast is a truncate, evaluting in a different type always
727     // eliminates the cast, so it is always a win.
728     LLVM_DEBUG(
729         dbgs() << "ICE: EvaluateInDifferentType converting expression type"
730                   " to avoid cast: "
731                << Trunc << '\n');
732     Value *Res = EvaluateInDifferentType(Src, DestTy, false);
733     assert(Res->getType() == DestTy);
734     return replaceInstUsesWith(Trunc, Res);
735   }
736 
737   // For integer types, check if we can shorten the entire input expression to
738   // DestWidth * 2, which won't allow removing the truncate, but reducing the
739   // width may enable further optimizations, e.g. allowing for larger
740   // vectorization factors.
741   if (auto *DestITy = dyn_cast<IntegerType>(DestTy)) {
742     if (DestWidth * 2 < SrcWidth) {
743       auto *NewDestTy = DestITy->getExtendedType();
744       if (shouldChangeType(SrcTy, NewDestTy) &&
745           canEvaluateTruncated(Src, NewDestTy, *this, &Trunc)) {
746         LLVM_DEBUG(
747             dbgs() << "ICE: EvaluateInDifferentType converting expression type"
748                       " to reduce the width of operand of"
749                    << Trunc << '\n');
750         Value *Res = EvaluateInDifferentType(Src, NewDestTy, false);
751         return new TruncInst(Res, DestTy);
752       }
753     }
754   }
755 
756   // Test if the trunc is the user of a select which is part of a
757   // minimum or maximum operation. If so, don't do any more simplification.
758   // Even simplifying demanded bits can break the canonical form of a
759   // min/max.
760   Value *LHS, *RHS;
761   if (SelectInst *Sel = dyn_cast<SelectInst>(Src))
762     if (matchSelectPattern(Sel, LHS, RHS).Flavor != SPF_UNKNOWN)
763       return nullptr;
764 
765   // See if we can simplify any instructions used by the input whose sole
766   // purpose is to compute bits we don't care about.
767   if (SimplifyDemandedInstructionBits(Trunc))
768     return &Trunc;
769 
770   if (DestWidth == 1) {
771     Value *Zero = Constant::getNullValue(SrcTy);
772     if (DestTy->isIntegerTy()) {
773       // Canonicalize trunc x to i1 -> icmp ne (and x, 1), 0 (scalar only).
774       // TODO: We canonicalize to more instructions here because we are probably
775       // lacking equivalent analysis for trunc relative to icmp. There may also
776       // be codegen concerns. If those trunc limitations were removed, we could
777       // remove this transform.
778       Value *And = Builder.CreateAnd(Src, ConstantInt::get(SrcTy, 1));
779       return new ICmpInst(ICmpInst::ICMP_NE, And, Zero);
780     }
781 
782     // For vectors, we do not canonicalize all truncs to icmp, so optimize
783     // patterns that would be covered within visitICmpInst.
784     Value *X;
785     Constant *C;
786     if (match(Src, m_OneUse(m_LShr(m_Value(X), m_Constant(C))))) {
787       // trunc (lshr X, C) to i1 --> icmp ne (and X, C'), 0
788       Constant *One = ConstantInt::get(SrcTy, APInt(SrcWidth, 1));
789       Constant *MaskC = ConstantExpr::getShl(One, C);
790       Value *And = Builder.CreateAnd(X, MaskC);
791       return new ICmpInst(ICmpInst::ICMP_NE, And, Zero);
792     }
793     if (match(Src, m_OneUse(m_c_Or(m_LShr(m_Value(X), m_Constant(C)),
794                                    m_Deferred(X))))) {
795       // trunc (or (lshr X, C), X) to i1 --> icmp ne (and X, C'), 0
796       Constant *One = ConstantInt::get(SrcTy, APInt(SrcWidth, 1));
797       Constant *MaskC = ConstantExpr::getShl(One, C);
798       MaskC = ConstantExpr::getOr(MaskC, One);
799       Value *And = Builder.CreateAnd(X, MaskC);
800       return new ICmpInst(ICmpInst::ICMP_NE, And, Zero);
801     }
802   }
803 
804   // FIXME: Maybe combine the next two transforms to handle the no cast case
805   // more efficiently. Support vector types. Cleanup code by using m_OneUse.
806 
807   // Transform trunc(lshr (zext A), Cst) to eliminate one type conversion.
808   Value *A = nullptr;
809   if (Src->hasOneUse() &&
810       match(Src, m_LShr(m_ZExt(m_Value(A)), m_ConstantInt(Cst)))) {
811     // We have three types to worry about here, the type of A, the source of
812     // the truncate (MidSize), and the destination of the truncate. We know that
813     // ASize < MidSize   and MidSize > ResultSize, but don't know the relation
814     // between ASize and ResultSize.
815     unsigned ASize = A->getType()->getPrimitiveSizeInBits();
816 
817     // If the shift amount is larger than the size of A, then the result is
818     // known to be zero because all the input bits got shifted out.
819     if (Cst->getZExtValue() >= ASize)
820       return replaceInstUsesWith(Trunc, Constant::getNullValue(DestTy));
821 
822     // Since we're doing an lshr and a zero extend, and know that the shift
823     // amount is smaller than ASize, it is always safe to do the shift in A's
824     // type, then zero extend or truncate to the result.
825     Value *Shift = Builder.CreateLShr(A, Cst->getZExtValue());
826     Shift->takeName(Src);
827     return CastInst::CreateIntegerCast(Shift, DestTy, false);
828   }
829 
830   const APInt *C;
831   if (match(Src, m_LShr(m_SExt(m_Value(A)), m_APInt(C)))) {
832     unsigned AWidth = A->getType()->getScalarSizeInBits();
833     unsigned MaxShiftAmt = SrcWidth - std::max(DestWidth, AWidth);
834 
835     // If the shift is small enough, all zero bits created by the shift are
836     // removed by the trunc.
837     if (C->getZExtValue() <= MaxShiftAmt) {
838       // trunc (lshr (sext A), C) --> ashr A, C
839       if (A->getType() == DestTy) {
840         unsigned ShAmt = std::min((unsigned)C->getZExtValue(), DestWidth - 1);
841         return BinaryOperator::CreateAShr(A, ConstantInt::get(DestTy, ShAmt));
842       }
843       // The types are mismatched, so create a cast after shifting:
844       // trunc (lshr (sext A), C) --> sext/trunc (ashr A, C)
845       if (Src->hasOneUse()) {
846         unsigned ShAmt = std::min((unsigned)C->getZExtValue(), AWidth - 1);
847         Value *Shift = Builder.CreateAShr(A, ShAmt);
848         return CastInst::CreateIntegerCast(Shift, DestTy, true);
849       }
850     }
851     // TODO: Mask high bits with 'and'.
852   }
853 
854   if (Instruction *I = narrowBinOp(Trunc))
855     return I;
856 
857   if (Instruction *I = shrinkSplatShuffle(Trunc, Builder))
858     return I;
859 
860   if (Instruction *I = shrinkInsertElt(Trunc, Builder))
861     return I;
862 
863   if (Src->hasOneUse() && isa<IntegerType>(SrcTy) &&
864       shouldChangeType(SrcTy, DestTy)) {
865     // Transform "trunc (shl X, cst)" -> "shl (trunc X), cst" so long as the
866     // dest type is native and cst < dest size.
867     if (match(Src, m_Shl(m_Value(A), m_ConstantInt(Cst))) &&
868         !match(A, m_Shr(m_Value(), m_Constant()))) {
869       // Skip shifts of shift by constants. It undoes a combine in
870       // FoldShiftByConstant and is the extend in reg pattern.
871       if (Cst->getValue().ult(DestWidth)) {
872         Value *NewTrunc = Builder.CreateTrunc(A, DestTy, A->getName() + ".tr");
873 
874         return BinaryOperator::Create(
875           Instruction::Shl, NewTrunc,
876           ConstantInt::get(DestTy, Cst->getValue().trunc(DestWidth)));
877       }
878     }
879   }
880 
881   if (Instruction *I = foldVecTruncToExtElt(Trunc, *this))
882     return I;
883 
884   // Whenever an element is extracted from a vector, and then truncated,
885   // canonicalize by converting it to a bitcast followed by an
886   // extractelement.
887   //
888   // Example (little endian):
889   //   trunc (extractelement <4 x i64> %X, 0) to i32
890   //   --->
891   //   extractelement <8 x i32> (bitcast <4 x i64> %X to <8 x i32>), i32 0
892   Value *VecOp;
893   if (match(Src, m_OneUse(m_ExtractElt(m_Value(VecOp), m_ConstantInt(Cst))))) {
894     auto *VecOpTy = cast<FixedVectorType>(VecOp->getType());
895     unsigned VecNumElts = VecOpTy->getNumElements();
896 
897     // A badly fit destination size would result in an invalid cast.
898     if (SrcWidth % DestWidth == 0) {
899       uint64_t TruncRatio = SrcWidth / DestWidth;
900       uint64_t BitCastNumElts = VecNumElts * TruncRatio;
901       uint64_t VecOpIdx = Cst->getZExtValue();
902       uint64_t NewIdx = DL.isBigEndian() ? (VecOpIdx + 1) * TruncRatio - 1
903                                          : VecOpIdx * TruncRatio;
904       assert(BitCastNumElts <= std::numeric_limits<uint32_t>::max() &&
905              "overflow 32-bits");
906 
907       auto *BitCastTo = FixedVectorType::get(DestTy, BitCastNumElts);
908       Value *BitCast = Builder.CreateBitCast(VecOp, BitCastTo);
909       return ExtractElementInst::Create(BitCast, Builder.getInt32(NewIdx));
910     }
911   }
912 
913   return nullptr;
914 }
915 
916 Instruction *InstCombinerImpl::transformZExtICmp(ICmpInst *Cmp, ZExtInst &Zext,
917                                                  bool DoTransform) {
918   // If we are just checking for a icmp eq of a single bit and zext'ing it
919   // to an integer, then shift the bit to the appropriate place and then
920   // cast to integer to avoid the comparison.
921   const APInt *Op1CV;
922   if (match(Cmp->getOperand(1), m_APInt(Op1CV))) {
923 
924     // zext (x <s  0) to i32 --> x>>u31      true if signbit set.
925     // zext (x >s -1) to i32 --> (x>>u31)^1  true if signbit clear.
926     if ((Cmp->getPredicate() == ICmpInst::ICMP_SLT && Op1CV->isNullValue()) ||
927         (Cmp->getPredicate() == ICmpInst::ICMP_SGT && Op1CV->isAllOnesValue())) {
928       if (!DoTransform) return Cmp;
929 
930       Value *In = Cmp->getOperand(0);
931       Value *Sh = ConstantInt::get(In->getType(),
932                                    In->getType()->getScalarSizeInBits() - 1);
933       In = Builder.CreateLShr(In, Sh, In->getName() + ".lobit");
934       if (In->getType() != Zext.getType())
935         In = Builder.CreateIntCast(In, Zext.getType(), false /*ZExt*/);
936 
937       if (Cmp->getPredicate() == ICmpInst::ICMP_SGT) {
938         Constant *One = ConstantInt::get(In->getType(), 1);
939         In = Builder.CreateXor(In, One, In->getName() + ".not");
940       }
941 
942       return replaceInstUsesWith(Zext, In);
943     }
944 
945     // zext (X == 0) to i32 --> X^1      iff X has only the low bit set.
946     // zext (X == 0) to i32 --> (X>>1)^1 iff X has only the 2nd bit set.
947     // zext (X == 1) to i32 --> X        iff X has only the low bit set.
948     // zext (X == 2) to i32 --> X>>1     iff X has only the 2nd bit set.
949     // zext (X != 0) to i32 --> X        iff X has only the low bit set.
950     // zext (X != 0) to i32 --> X>>1     iff X has only the 2nd bit set.
951     // zext (X != 1) to i32 --> X^1      iff X has only the low bit set.
952     // zext (X != 2) to i32 --> (X>>1)^1 iff X has only the 2nd bit set.
953     if ((Op1CV->isNullValue() || Op1CV->isPowerOf2()) &&
954         // This only works for EQ and NE
955         Cmp->isEquality()) {
956       // If Op1C some other power of two, convert:
957       KnownBits Known = computeKnownBits(Cmp->getOperand(0), 0, &Zext);
958 
959       APInt KnownZeroMask(~Known.Zero);
960       if (KnownZeroMask.isPowerOf2()) { // Exactly 1 possible 1?
961         if (!DoTransform) return Cmp;
962 
963         bool isNE = Cmp->getPredicate() == ICmpInst::ICMP_NE;
964         if (!Op1CV->isNullValue() && (*Op1CV != KnownZeroMask)) {
965           // (X&4) == 2 --> false
966           // (X&4) != 2 --> true
967           Constant *Res = ConstantInt::get(Zext.getType(), isNE);
968           return replaceInstUsesWith(Zext, Res);
969         }
970 
971         uint32_t ShAmt = KnownZeroMask.logBase2();
972         Value *In = Cmp->getOperand(0);
973         if (ShAmt) {
974           // Perform a logical shr by shiftamt.
975           // Insert the shift to put the result in the low bit.
976           In = Builder.CreateLShr(In, ConstantInt::get(In->getType(), ShAmt),
977                                   In->getName() + ".lobit");
978         }
979 
980         if (!Op1CV->isNullValue() == isNE) { // Toggle the low bit.
981           Constant *One = ConstantInt::get(In->getType(), 1);
982           In = Builder.CreateXor(In, One);
983         }
984 
985         if (Zext.getType() == In->getType())
986           return replaceInstUsesWith(Zext, In);
987 
988         Value *IntCast = Builder.CreateIntCast(In, Zext.getType(), false);
989         return replaceInstUsesWith(Zext, IntCast);
990       }
991     }
992   }
993 
994   // icmp ne A, B is equal to xor A, B when A and B only really have one bit.
995   // It is also profitable to transform icmp eq into not(xor(A, B)) because that
996   // may lead to additional simplifications.
997   if (Cmp->isEquality() && Zext.getType() == Cmp->getOperand(0)->getType()) {
998     if (IntegerType *ITy = dyn_cast<IntegerType>(Zext.getType())) {
999       Value *LHS = Cmp->getOperand(0);
1000       Value *RHS = Cmp->getOperand(1);
1001 
1002       KnownBits KnownLHS = computeKnownBits(LHS, 0, &Zext);
1003       KnownBits KnownRHS = computeKnownBits(RHS, 0, &Zext);
1004 
1005       if (KnownLHS.Zero == KnownRHS.Zero && KnownLHS.One == KnownRHS.One) {
1006         APInt KnownBits = KnownLHS.Zero | KnownLHS.One;
1007         APInt UnknownBit = ~KnownBits;
1008         if (UnknownBit.countPopulation() == 1) {
1009           if (!DoTransform) return Cmp;
1010 
1011           Value *Result = Builder.CreateXor(LHS, RHS);
1012 
1013           // Mask off any bits that are set and won't be shifted away.
1014           if (KnownLHS.One.uge(UnknownBit))
1015             Result = Builder.CreateAnd(Result,
1016                                         ConstantInt::get(ITy, UnknownBit));
1017 
1018           // Shift the bit we're testing down to the lsb.
1019           Result = Builder.CreateLShr(
1020                Result, ConstantInt::get(ITy, UnknownBit.countTrailingZeros()));
1021 
1022           if (Cmp->getPredicate() == ICmpInst::ICMP_EQ)
1023             Result = Builder.CreateXor(Result, ConstantInt::get(ITy, 1));
1024           Result->takeName(Cmp);
1025           return replaceInstUsesWith(Zext, Result);
1026         }
1027       }
1028     }
1029   }
1030 
1031   return nullptr;
1032 }
1033 
1034 /// Determine if the specified value can be computed in the specified wider type
1035 /// and produce the same low bits. If not, return false.
1036 ///
1037 /// If this function returns true, it can also return a non-zero number of bits
1038 /// (in BitsToClear) which indicates that the value it computes is correct for
1039 /// the zero extend, but that the additional BitsToClear bits need to be zero'd
1040 /// out.  For example, to promote something like:
1041 ///
1042 ///   %B = trunc i64 %A to i32
1043 ///   %C = lshr i32 %B, 8
1044 ///   %E = zext i32 %C to i64
1045 ///
1046 /// CanEvaluateZExtd for the 'lshr' will return true, and BitsToClear will be
1047 /// set to 8 to indicate that the promoted value needs to have bits 24-31
1048 /// cleared in addition to bits 32-63.  Since an 'and' will be generated to
1049 /// clear the top bits anyway, doing this has no extra cost.
1050 ///
1051 /// This function works on both vectors and scalars.
1052 static bool canEvaluateZExtd(Value *V, Type *Ty, unsigned &BitsToClear,
1053                              InstCombinerImpl &IC, Instruction *CxtI) {
1054   BitsToClear = 0;
1055   if (canAlwaysEvaluateInType(V, Ty))
1056     return true;
1057   if (canNotEvaluateInType(V, Ty))
1058     return false;
1059 
1060   auto *I = cast<Instruction>(V);
1061   unsigned Tmp;
1062   switch (I->getOpcode()) {
1063   case Instruction::ZExt:  // zext(zext(x)) -> zext(x).
1064   case Instruction::SExt:  // zext(sext(x)) -> sext(x).
1065   case Instruction::Trunc: // zext(trunc(x)) -> trunc(x) or zext(x)
1066     return true;
1067   case Instruction::And:
1068   case Instruction::Or:
1069   case Instruction::Xor:
1070   case Instruction::Add:
1071   case Instruction::Sub:
1072   case Instruction::Mul:
1073     if (!canEvaluateZExtd(I->getOperand(0), Ty, BitsToClear, IC, CxtI) ||
1074         !canEvaluateZExtd(I->getOperand(1), Ty, Tmp, IC, CxtI))
1075       return false;
1076     // These can all be promoted if neither operand has 'bits to clear'.
1077     if (BitsToClear == 0 && Tmp == 0)
1078       return true;
1079 
1080     // If the operation is an AND/OR/XOR and the bits to clear are zero in the
1081     // other side, BitsToClear is ok.
1082     if (Tmp == 0 && I->isBitwiseLogicOp()) {
1083       // We use MaskedValueIsZero here for generality, but the case we care
1084       // about the most is constant RHS.
1085       unsigned VSize = V->getType()->getScalarSizeInBits();
1086       if (IC.MaskedValueIsZero(I->getOperand(1),
1087                                APInt::getHighBitsSet(VSize, BitsToClear),
1088                                0, CxtI)) {
1089         // If this is an And instruction and all of the BitsToClear are
1090         // known to be zero we can reset BitsToClear.
1091         if (I->getOpcode() == Instruction::And)
1092           BitsToClear = 0;
1093         return true;
1094       }
1095     }
1096 
1097     // Otherwise, we don't know how to analyze this BitsToClear case yet.
1098     return false;
1099 
1100   case Instruction::Shl: {
1101     // We can promote shl(x, cst) if we can promote x.  Since shl overwrites the
1102     // upper bits we can reduce BitsToClear by the shift amount.
1103     const APInt *Amt;
1104     if (match(I->getOperand(1), m_APInt(Amt))) {
1105       if (!canEvaluateZExtd(I->getOperand(0), Ty, BitsToClear, IC, CxtI))
1106         return false;
1107       uint64_t ShiftAmt = Amt->getZExtValue();
1108       BitsToClear = ShiftAmt < BitsToClear ? BitsToClear - ShiftAmt : 0;
1109       return true;
1110     }
1111     return false;
1112   }
1113   case Instruction::LShr: {
1114     // We can promote lshr(x, cst) if we can promote x.  This requires the
1115     // ultimate 'and' to clear out the high zero bits we're clearing out though.
1116     const APInt *Amt;
1117     if (match(I->getOperand(1), m_APInt(Amt))) {
1118       if (!canEvaluateZExtd(I->getOperand(0), Ty, BitsToClear, IC, CxtI))
1119         return false;
1120       BitsToClear += Amt->getZExtValue();
1121       if (BitsToClear > V->getType()->getScalarSizeInBits())
1122         BitsToClear = V->getType()->getScalarSizeInBits();
1123       return true;
1124     }
1125     // Cannot promote variable LSHR.
1126     return false;
1127   }
1128   case Instruction::Select:
1129     if (!canEvaluateZExtd(I->getOperand(1), Ty, Tmp, IC, CxtI) ||
1130         !canEvaluateZExtd(I->getOperand(2), Ty, BitsToClear, IC, CxtI) ||
1131         // TODO: If important, we could handle the case when the BitsToClear are
1132         // known zero in the disagreeing side.
1133         Tmp != BitsToClear)
1134       return false;
1135     return true;
1136 
1137   case Instruction::PHI: {
1138     // We can change a phi if we can change all operands.  Note that we never
1139     // get into trouble with cyclic PHIs here because we only consider
1140     // instructions with a single use.
1141     PHINode *PN = cast<PHINode>(I);
1142     if (!canEvaluateZExtd(PN->getIncomingValue(0), Ty, BitsToClear, IC, CxtI))
1143       return false;
1144     for (unsigned i = 1, e = PN->getNumIncomingValues(); i != e; ++i)
1145       if (!canEvaluateZExtd(PN->getIncomingValue(i), Ty, Tmp, IC, CxtI) ||
1146           // TODO: If important, we could handle the case when the BitsToClear
1147           // are known zero in the disagreeing input.
1148           Tmp != BitsToClear)
1149         return false;
1150     return true;
1151   }
1152   default:
1153     // TODO: Can handle more cases here.
1154     return false;
1155   }
1156 }
1157 
1158 Instruction *InstCombinerImpl::visitZExt(ZExtInst &CI) {
1159   // If this zero extend is only used by a truncate, let the truncate be
1160   // eliminated before we try to optimize this zext.
1161   if (CI.hasOneUse() && isa<TruncInst>(CI.user_back()))
1162     return nullptr;
1163 
1164   // If one of the common conversion will work, do it.
1165   if (Instruction *Result = commonCastTransforms(CI))
1166     return Result;
1167 
1168   Value *Src = CI.getOperand(0);
1169   Type *SrcTy = Src->getType(), *DestTy = CI.getType();
1170 
1171   // Try to extend the entire expression tree to the wide destination type.
1172   unsigned BitsToClear;
1173   if (shouldChangeType(SrcTy, DestTy) &&
1174       canEvaluateZExtd(Src, DestTy, BitsToClear, *this, &CI)) {
1175     assert(BitsToClear <= SrcTy->getScalarSizeInBits() &&
1176            "Can't clear more bits than in SrcTy");
1177 
1178     // Okay, we can transform this!  Insert the new expression now.
1179     LLVM_DEBUG(
1180         dbgs() << "ICE: EvaluateInDifferentType converting expression type"
1181                   " to avoid zero extend: "
1182                << CI << '\n');
1183     Value *Res = EvaluateInDifferentType(Src, DestTy, false);
1184     assert(Res->getType() == DestTy);
1185 
1186     // Preserve debug values referring to Src if the zext is its last use.
1187     if (auto *SrcOp = dyn_cast<Instruction>(Src))
1188       if (SrcOp->hasOneUse())
1189         replaceAllDbgUsesWith(*SrcOp, *Res, CI, DT);
1190 
1191     uint32_t SrcBitsKept = SrcTy->getScalarSizeInBits()-BitsToClear;
1192     uint32_t DestBitSize = DestTy->getScalarSizeInBits();
1193 
1194     // If the high bits are already filled with zeros, just replace this
1195     // cast with the result.
1196     if (MaskedValueIsZero(Res,
1197                           APInt::getHighBitsSet(DestBitSize,
1198                                                 DestBitSize-SrcBitsKept),
1199                              0, &CI))
1200       return replaceInstUsesWith(CI, Res);
1201 
1202     // We need to emit an AND to clear the high bits.
1203     Constant *C = ConstantInt::get(Res->getType(),
1204                                APInt::getLowBitsSet(DestBitSize, SrcBitsKept));
1205     return BinaryOperator::CreateAnd(Res, C);
1206   }
1207 
1208   // If this is a TRUNC followed by a ZEXT then we are dealing with integral
1209   // types and if the sizes are just right we can convert this into a logical
1210   // 'and' which will be much cheaper than the pair of casts.
1211   if (TruncInst *CSrc = dyn_cast<TruncInst>(Src)) {   // A->B->C cast
1212     // TODO: Subsume this into EvaluateInDifferentType.
1213 
1214     // Get the sizes of the types involved.  We know that the intermediate type
1215     // will be smaller than A or C, but don't know the relation between A and C.
1216     Value *A = CSrc->getOperand(0);
1217     unsigned SrcSize = A->getType()->getScalarSizeInBits();
1218     unsigned MidSize = CSrc->getType()->getScalarSizeInBits();
1219     unsigned DstSize = CI.getType()->getScalarSizeInBits();
1220     // If we're actually extending zero bits, then if
1221     // SrcSize <  DstSize: zext(a & mask)
1222     // SrcSize == DstSize: a & mask
1223     // SrcSize  > DstSize: trunc(a) & mask
1224     if (SrcSize < DstSize) {
1225       APInt AndValue(APInt::getLowBitsSet(SrcSize, MidSize));
1226       Constant *AndConst = ConstantInt::get(A->getType(), AndValue);
1227       Value *And = Builder.CreateAnd(A, AndConst, CSrc->getName() + ".mask");
1228       return new ZExtInst(And, CI.getType());
1229     }
1230 
1231     if (SrcSize == DstSize) {
1232       APInt AndValue(APInt::getLowBitsSet(SrcSize, MidSize));
1233       return BinaryOperator::CreateAnd(A, ConstantInt::get(A->getType(),
1234                                                            AndValue));
1235     }
1236     if (SrcSize > DstSize) {
1237       Value *Trunc = Builder.CreateTrunc(A, CI.getType());
1238       APInt AndValue(APInt::getLowBitsSet(DstSize, MidSize));
1239       return BinaryOperator::CreateAnd(Trunc,
1240                                        ConstantInt::get(Trunc->getType(),
1241                                                         AndValue));
1242     }
1243   }
1244 
1245   if (ICmpInst *Cmp = dyn_cast<ICmpInst>(Src))
1246     return transformZExtICmp(Cmp, CI);
1247 
1248   BinaryOperator *SrcI = dyn_cast<BinaryOperator>(Src);
1249   if (SrcI && SrcI->getOpcode() == Instruction::Or) {
1250     // zext (or icmp, icmp) -> or (zext icmp), (zext icmp) if at least one
1251     // of the (zext icmp) can be eliminated. If so, immediately perform the
1252     // according elimination.
1253     ICmpInst *LHS = dyn_cast<ICmpInst>(SrcI->getOperand(0));
1254     ICmpInst *RHS = dyn_cast<ICmpInst>(SrcI->getOperand(1));
1255     if (LHS && RHS && LHS->hasOneUse() && RHS->hasOneUse() &&
1256         (transformZExtICmp(LHS, CI, false) ||
1257          transformZExtICmp(RHS, CI, false))) {
1258       // zext (or icmp, icmp) -> or (zext icmp), (zext icmp)
1259       Value *LCast = Builder.CreateZExt(LHS, CI.getType(), LHS->getName());
1260       Value *RCast = Builder.CreateZExt(RHS, CI.getType(), RHS->getName());
1261       Value *Or = Builder.CreateOr(LCast, RCast, CI.getName());
1262       if (auto *OrInst = dyn_cast<Instruction>(Or))
1263         Builder.SetInsertPoint(OrInst);
1264 
1265       // Perform the elimination.
1266       if (auto *LZExt = dyn_cast<ZExtInst>(LCast))
1267         transformZExtICmp(LHS, *LZExt);
1268       if (auto *RZExt = dyn_cast<ZExtInst>(RCast))
1269         transformZExtICmp(RHS, *RZExt);
1270 
1271       return replaceInstUsesWith(CI, Or);
1272     }
1273   }
1274 
1275   // zext(trunc(X) & C) -> (X & zext(C)).
1276   Constant *C;
1277   Value *X;
1278   if (SrcI &&
1279       match(SrcI, m_OneUse(m_And(m_Trunc(m_Value(X)), m_Constant(C)))) &&
1280       X->getType() == CI.getType())
1281     return BinaryOperator::CreateAnd(X, ConstantExpr::getZExt(C, CI.getType()));
1282 
1283   // zext((trunc(X) & C) ^ C) -> ((X & zext(C)) ^ zext(C)).
1284   Value *And;
1285   if (SrcI && match(SrcI, m_OneUse(m_Xor(m_Value(And), m_Constant(C)))) &&
1286       match(And, m_OneUse(m_And(m_Trunc(m_Value(X)), m_Specific(C)))) &&
1287       X->getType() == CI.getType()) {
1288     Constant *ZC = ConstantExpr::getZExt(C, CI.getType());
1289     return BinaryOperator::CreateXor(Builder.CreateAnd(X, ZC), ZC);
1290   }
1291 
1292   return nullptr;
1293 }
1294 
1295 /// Transform (sext icmp) to bitwise / integer operations to eliminate the icmp.
1296 Instruction *InstCombinerImpl::transformSExtICmp(ICmpInst *ICI,
1297                                                  Instruction &CI) {
1298   Value *Op0 = ICI->getOperand(0), *Op1 = ICI->getOperand(1);
1299   ICmpInst::Predicate Pred = ICI->getPredicate();
1300 
1301   // Don't bother if Op1 isn't of vector or integer type.
1302   if (!Op1->getType()->isIntOrIntVectorTy())
1303     return nullptr;
1304 
1305   if ((Pred == ICmpInst::ICMP_SLT && match(Op1, m_ZeroInt())) ||
1306       (Pred == ICmpInst::ICMP_SGT && match(Op1, m_AllOnes()))) {
1307     // (x <s  0) ? -1 : 0 -> ashr x, 31        -> all ones if negative
1308     // (x >s -1) ? -1 : 0 -> not (ashr x, 31)  -> all ones if positive
1309     Value *Sh = ConstantInt::get(Op0->getType(),
1310                                  Op0->getType()->getScalarSizeInBits() - 1);
1311     Value *In = Builder.CreateAShr(Op0, Sh, Op0->getName() + ".lobit");
1312     if (In->getType() != CI.getType())
1313       In = Builder.CreateIntCast(In, CI.getType(), true /*SExt*/);
1314 
1315     if (Pred == ICmpInst::ICMP_SGT)
1316       In = Builder.CreateNot(In, In->getName() + ".not");
1317     return replaceInstUsesWith(CI, In);
1318   }
1319 
1320   if (ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
1321     // If we know that only one bit of the LHS of the icmp can be set and we
1322     // have an equality comparison with zero or a power of 2, we can transform
1323     // the icmp and sext into bitwise/integer operations.
1324     if (ICI->hasOneUse() &&
1325         ICI->isEquality() && (Op1C->isZero() || Op1C->getValue().isPowerOf2())){
1326       KnownBits Known = computeKnownBits(Op0, 0, &CI);
1327 
1328       APInt KnownZeroMask(~Known.Zero);
1329       if (KnownZeroMask.isPowerOf2()) {
1330         Value *In = ICI->getOperand(0);
1331 
1332         // If the icmp tests for a known zero bit we can constant fold it.
1333         if (!Op1C->isZero() && Op1C->getValue() != KnownZeroMask) {
1334           Value *V = Pred == ICmpInst::ICMP_NE ?
1335                        ConstantInt::getAllOnesValue(CI.getType()) :
1336                        ConstantInt::getNullValue(CI.getType());
1337           return replaceInstUsesWith(CI, V);
1338         }
1339 
1340         if (!Op1C->isZero() == (Pred == ICmpInst::ICMP_NE)) {
1341           // sext ((x & 2^n) == 0)   -> (x >> n) - 1
1342           // sext ((x & 2^n) != 2^n) -> (x >> n) - 1
1343           unsigned ShiftAmt = KnownZeroMask.countTrailingZeros();
1344           // Perform a right shift to place the desired bit in the LSB.
1345           if (ShiftAmt)
1346             In = Builder.CreateLShr(In,
1347                                     ConstantInt::get(In->getType(), ShiftAmt));
1348 
1349           // At this point "In" is either 1 or 0. Subtract 1 to turn
1350           // {1, 0} -> {0, -1}.
1351           In = Builder.CreateAdd(In,
1352                                  ConstantInt::getAllOnesValue(In->getType()),
1353                                  "sext");
1354         } else {
1355           // sext ((x & 2^n) != 0)   -> (x << bitwidth-n) a>> bitwidth-1
1356           // sext ((x & 2^n) == 2^n) -> (x << bitwidth-n) a>> bitwidth-1
1357           unsigned ShiftAmt = KnownZeroMask.countLeadingZeros();
1358           // Perform a left shift to place the desired bit in the MSB.
1359           if (ShiftAmt)
1360             In = Builder.CreateShl(In,
1361                                    ConstantInt::get(In->getType(), ShiftAmt));
1362 
1363           // Distribute the bit over the whole bit width.
1364           In = Builder.CreateAShr(In, ConstantInt::get(In->getType(),
1365                                   KnownZeroMask.getBitWidth() - 1), "sext");
1366         }
1367 
1368         if (CI.getType() == In->getType())
1369           return replaceInstUsesWith(CI, In);
1370         return CastInst::CreateIntegerCast(In, CI.getType(), true/*SExt*/);
1371       }
1372     }
1373   }
1374 
1375   return nullptr;
1376 }
1377 
1378 /// Return true if we can take the specified value and return it as type Ty
1379 /// without inserting any new casts and without changing the value of the common
1380 /// low bits.  This is used by code that tries to promote integer operations to
1381 /// a wider types will allow us to eliminate the extension.
1382 ///
1383 /// This function works on both vectors and scalars.
1384 ///
1385 static bool canEvaluateSExtd(Value *V, Type *Ty) {
1386   assert(V->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits() &&
1387          "Can't sign extend type to a smaller type");
1388   if (canAlwaysEvaluateInType(V, Ty))
1389     return true;
1390   if (canNotEvaluateInType(V, Ty))
1391     return false;
1392 
1393   auto *I = cast<Instruction>(V);
1394   switch (I->getOpcode()) {
1395   case Instruction::SExt:  // sext(sext(x)) -> sext(x)
1396   case Instruction::ZExt:  // sext(zext(x)) -> zext(x)
1397   case Instruction::Trunc: // sext(trunc(x)) -> trunc(x) or sext(x)
1398     return true;
1399   case Instruction::And:
1400   case Instruction::Or:
1401   case Instruction::Xor:
1402   case Instruction::Add:
1403   case Instruction::Sub:
1404   case Instruction::Mul:
1405     // These operators can all arbitrarily be extended if their inputs can.
1406     return canEvaluateSExtd(I->getOperand(0), Ty) &&
1407            canEvaluateSExtd(I->getOperand(1), Ty);
1408 
1409   //case Instruction::Shl:   TODO
1410   //case Instruction::LShr:  TODO
1411 
1412   case Instruction::Select:
1413     return canEvaluateSExtd(I->getOperand(1), Ty) &&
1414            canEvaluateSExtd(I->getOperand(2), Ty);
1415 
1416   case Instruction::PHI: {
1417     // We can change a phi if we can change all operands.  Note that we never
1418     // get into trouble with cyclic PHIs here because we only consider
1419     // instructions with a single use.
1420     PHINode *PN = cast<PHINode>(I);
1421     for (Value *IncValue : PN->incoming_values())
1422       if (!canEvaluateSExtd(IncValue, Ty)) return false;
1423     return true;
1424   }
1425   default:
1426     // TODO: Can handle more cases here.
1427     break;
1428   }
1429 
1430   return false;
1431 }
1432 
1433 Instruction *InstCombinerImpl::visitSExt(SExtInst &CI) {
1434   // If this sign extend is only used by a truncate, let the truncate be
1435   // eliminated before we try to optimize this sext.
1436   if (CI.hasOneUse() && isa<TruncInst>(CI.user_back()))
1437     return nullptr;
1438 
1439   if (Instruction *I = commonCastTransforms(CI))
1440     return I;
1441 
1442   Value *Src = CI.getOperand(0);
1443   Type *SrcTy = Src->getType(), *DestTy = CI.getType();
1444 
1445   // If we know that the value being extended is positive, we can use a zext
1446   // instead.
1447   KnownBits Known = computeKnownBits(Src, 0, &CI);
1448   if (Known.isNonNegative())
1449     return CastInst::Create(Instruction::ZExt, Src, DestTy);
1450 
1451   // Try to extend the entire expression tree to the wide destination type.
1452   if (shouldChangeType(SrcTy, DestTy) && canEvaluateSExtd(Src, DestTy)) {
1453     // Okay, we can transform this!  Insert the new expression now.
1454     LLVM_DEBUG(
1455         dbgs() << "ICE: EvaluateInDifferentType converting expression type"
1456                   " to avoid sign extend: "
1457                << CI << '\n');
1458     Value *Res = EvaluateInDifferentType(Src, DestTy, true);
1459     assert(Res->getType() == DestTy);
1460 
1461     uint32_t SrcBitSize = SrcTy->getScalarSizeInBits();
1462     uint32_t DestBitSize = DestTy->getScalarSizeInBits();
1463 
1464     // If the high bits are already filled with sign bit, just replace this
1465     // cast with the result.
1466     if (ComputeNumSignBits(Res, 0, &CI) > DestBitSize - SrcBitSize)
1467       return replaceInstUsesWith(CI, Res);
1468 
1469     // We need to emit a shl + ashr to do the sign extend.
1470     Value *ShAmt = ConstantInt::get(DestTy, DestBitSize-SrcBitSize);
1471     return BinaryOperator::CreateAShr(Builder.CreateShl(Res, ShAmt, "sext"),
1472                                       ShAmt);
1473   }
1474 
1475   // If the input is a trunc from the destination type, then turn sext(trunc(x))
1476   // into shifts.
1477   Value *X;
1478   if (match(Src, m_OneUse(m_Trunc(m_Value(X)))) && X->getType() == DestTy) {
1479     // sext(trunc(X)) --> ashr(shl(X, C), C)
1480     unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1481     unsigned DestBitSize = DestTy->getScalarSizeInBits();
1482     Constant *ShAmt = ConstantInt::get(DestTy, DestBitSize - SrcBitSize);
1483     return BinaryOperator::CreateAShr(Builder.CreateShl(X, ShAmt), ShAmt);
1484   }
1485 
1486   if (ICmpInst *ICI = dyn_cast<ICmpInst>(Src))
1487     return transformSExtICmp(ICI, CI);
1488 
1489   // If the input is a shl/ashr pair of a same constant, then this is a sign
1490   // extension from a smaller value.  If we could trust arbitrary bitwidth
1491   // integers, we could turn this into a truncate to the smaller bit and then
1492   // use a sext for the whole extension.  Since we don't, look deeper and check
1493   // for a truncate.  If the source and dest are the same type, eliminate the
1494   // trunc and extend and just do shifts.  For example, turn:
1495   //   %a = trunc i32 %i to i8
1496   //   %b = shl i8 %a, 6
1497   //   %c = ashr i8 %b, 6
1498   //   %d = sext i8 %c to i32
1499   // into:
1500   //   %a = shl i32 %i, 30
1501   //   %d = ashr i32 %a, 30
1502   Value *A = nullptr;
1503   // TODO: Eventually this could be subsumed by EvaluateInDifferentType.
1504   Constant *BA = nullptr, *CA = nullptr;
1505   if (match(Src, m_AShr(m_Shl(m_Trunc(m_Value(A)), m_Constant(BA)),
1506                         m_Constant(CA))) &&
1507       BA == CA && A->getType() == CI.getType()) {
1508     unsigned MidSize = Src->getType()->getScalarSizeInBits();
1509     unsigned SrcDstSize = CI.getType()->getScalarSizeInBits();
1510     Constant *SizeDiff = ConstantInt::get(CA->getType(), SrcDstSize - MidSize);
1511     Constant *ShAmt = ConstantExpr::getAdd(CA, SizeDiff);
1512     Constant *ShAmtExt = ConstantExpr::getSExt(ShAmt, CI.getType());
1513     A = Builder.CreateShl(A, ShAmtExt, CI.getName());
1514     return BinaryOperator::CreateAShr(A, ShAmtExt);
1515   }
1516 
1517   return nullptr;
1518 }
1519 
1520 /// Return a Constant* for the specified floating-point constant if it fits
1521 /// in the specified FP type without changing its value.
1522 static bool fitsInFPType(ConstantFP *CFP, const fltSemantics &Sem) {
1523   bool losesInfo;
1524   APFloat F = CFP->getValueAPF();
1525   (void)F.convert(Sem, APFloat::rmNearestTiesToEven, &losesInfo);
1526   return !losesInfo;
1527 }
1528 
1529 static Type *shrinkFPConstant(ConstantFP *CFP) {
1530   if (CFP->getType() == Type::getPPC_FP128Ty(CFP->getContext()))
1531     return nullptr;  // No constant folding of this.
1532   // See if the value can be truncated to half and then reextended.
1533   if (fitsInFPType(CFP, APFloat::IEEEhalf()))
1534     return Type::getHalfTy(CFP->getContext());
1535   // See if the value can be truncated to float and then reextended.
1536   if (fitsInFPType(CFP, APFloat::IEEEsingle()))
1537     return Type::getFloatTy(CFP->getContext());
1538   if (CFP->getType()->isDoubleTy())
1539     return nullptr;  // Won't shrink.
1540   if (fitsInFPType(CFP, APFloat::IEEEdouble()))
1541     return Type::getDoubleTy(CFP->getContext());
1542   // Don't try to shrink to various long double types.
1543   return nullptr;
1544 }
1545 
1546 // Determine if this is a vector of ConstantFPs and if so, return the minimal
1547 // type we can safely truncate all elements to.
1548 // TODO: Make these support undef elements.
1549 static Type *shrinkFPConstantVector(Value *V) {
1550   auto *CV = dyn_cast<Constant>(V);
1551   auto *CVVTy = dyn_cast<VectorType>(V->getType());
1552   if (!CV || !CVVTy)
1553     return nullptr;
1554 
1555   Type *MinType = nullptr;
1556 
1557   unsigned NumElts = cast<FixedVectorType>(CVVTy)->getNumElements();
1558   for (unsigned i = 0; i != NumElts; ++i) {
1559     auto *CFP = dyn_cast_or_null<ConstantFP>(CV->getAggregateElement(i));
1560     if (!CFP)
1561       return nullptr;
1562 
1563     Type *T = shrinkFPConstant(CFP);
1564     if (!T)
1565       return nullptr;
1566 
1567     // If we haven't found a type yet or this type has a larger mantissa than
1568     // our previous type, this is our new minimal type.
1569     if (!MinType || T->getFPMantissaWidth() > MinType->getFPMantissaWidth())
1570       MinType = T;
1571   }
1572 
1573   // Make a vector type from the minimal type.
1574   return FixedVectorType::get(MinType, NumElts);
1575 }
1576 
1577 /// Find the minimum FP type we can safely truncate to.
1578 static Type *getMinimumFPType(Value *V) {
1579   if (auto *FPExt = dyn_cast<FPExtInst>(V))
1580     return FPExt->getOperand(0)->getType();
1581 
1582   // If this value is a constant, return the constant in the smallest FP type
1583   // that can accurately represent it.  This allows us to turn
1584   // (float)((double)X+2.0) into x+2.0f.
1585   if (auto *CFP = dyn_cast<ConstantFP>(V))
1586     if (Type *T = shrinkFPConstant(CFP))
1587       return T;
1588 
1589   // Try to shrink a vector of FP constants.
1590   if (Type *T = shrinkFPConstantVector(V))
1591     return T;
1592 
1593   return V->getType();
1594 }
1595 
1596 /// Return true if the cast from integer to FP can be proven to be exact for all
1597 /// possible inputs (the conversion does not lose any precision).
1598 static bool isKnownExactCastIntToFP(CastInst &I) {
1599   CastInst::CastOps Opcode = I.getOpcode();
1600   assert((Opcode == CastInst::SIToFP || Opcode == CastInst::UIToFP) &&
1601          "Unexpected cast");
1602   Value *Src = I.getOperand(0);
1603   Type *SrcTy = Src->getType();
1604   Type *FPTy = I.getType();
1605   bool IsSigned = Opcode == Instruction::SIToFP;
1606   int SrcSize = (int)SrcTy->getScalarSizeInBits() - IsSigned;
1607 
1608   // Easy case - if the source integer type has less bits than the FP mantissa,
1609   // then the cast must be exact.
1610   int DestNumSigBits = FPTy->getFPMantissaWidth();
1611   if (SrcSize <= DestNumSigBits)
1612     return true;
1613 
1614   // Cast from FP to integer and back to FP is independent of the intermediate
1615   // integer width because of poison on overflow.
1616   Value *F;
1617   if (match(Src, m_FPToSI(m_Value(F))) || match(Src, m_FPToUI(m_Value(F)))) {
1618     // If this is uitofp (fptosi F), the source needs an extra bit to avoid
1619     // potential rounding of negative FP input values.
1620     int SrcNumSigBits = F->getType()->getFPMantissaWidth();
1621     if (!IsSigned && match(Src, m_FPToSI(m_Value())))
1622       SrcNumSigBits++;
1623 
1624     // [su]itofp (fpto[su]i F) --> exact if the source type has less or equal
1625     // significant bits than the destination (and make sure neither type is
1626     // weird -- ppc_fp128).
1627     if (SrcNumSigBits > 0 && DestNumSigBits > 0 &&
1628         SrcNumSigBits <= DestNumSigBits)
1629       return true;
1630   }
1631 
1632   // TODO:
1633   // Try harder to find if the source integer type has less significant bits.
1634   // For example, compute number of sign bits or compute low bit mask.
1635   return false;
1636 }
1637 
1638 Instruction *InstCombinerImpl::visitFPTrunc(FPTruncInst &FPT) {
1639   if (Instruction *I = commonCastTransforms(FPT))
1640     return I;
1641 
1642   // If we have fptrunc(OpI (fpextend x), (fpextend y)), we would like to
1643   // simplify this expression to avoid one or more of the trunc/extend
1644   // operations if we can do so without changing the numerical results.
1645   //
1646   // The exact manner in which the widths of the operands interact to limit
1647   // what we can and cannot do safely varies from operation to operation, and
1648   // is explained below in the various case statements.
1649   Type *Ty = FPT.getType();
1650   auto *BO = dyn_cast<BinaryOperator>(FPT.getOperand(0));
1651   if (BO && BO->hasOneUse()) {
1652     Type *LHSMinType = getMinimumFPType(BO->getOperand(0));
1653     Type *RHSMinType = getMinimumFPType(BO->getOperand(1));
1654     unsigned OpWidth = BO->getType()->getFPMantissaWidth();
1655     unsigned LHSWidth = LHSMinType->getFPMantissaWidth();
1656     unsigned RHSWidth = RHSMinType->getFPMantissaWidth();
1657     unsigned SrcWidth = std::max(LHSWidth, RHSWidth);
1658     unsigned DstWidth = Ty->getFPMantissaWidth();
1659     switch (BO->getOpcode()) {
1660       default: break;
1661       case Instruction::FAdd:
1662       case Instruction::FSub:
1663         // For addition and subtraction, the infinitely precise result can
1664         // essentially be arbitrarily wide; proving that double rounding
1665         // will not occur because the result of OpI is exact (as we will for
1666         // FMul, for example) is hopeless.  However, we *can* nonetheless
1667         // frequently know that double rounding cannot occur (or that it is
1668         // innocuous) by taking advantage of the specific structure of
1669         // infinitely-precise results that admit double rounding.
1670         //
1671         // Specifically, if OpWidth >= 2*DstWdith+1 and DstWidth is sufficient
1672         // to represent both sources, we can guarantee that the double
1673         // rounding is innocuous (See p50 of Figueroa's 2000 PhD thesis,
1674         // "A Rigorous Framework for Fully Supporting the IEEE Standard ..."
1675         // for proof of this fact).
1676         //
1677         // Note: Figueroa does not consider the case where DstFormat !=
1678         // SrcFormat.  It's possible (likely even!) that this analysis
1679         // could be tightened for those cases, but they are rare (the main
1680         // case of interest here is (float)((double)float + float)).
1681         if (OpWidth >= 2*DstWidth+1 && DstWidth >= SrcWidth) {
1682           Value *LHS = Builder.CreateFPTrunc(BO->getOperand(0), Ty);
1683           Value *RHS = Builder.CreateFPTrunc(BO->getOperand(1), Ty);
1684           Instruction *RI = BinaryOperator::Create(BO->getOpcode(), LHS, RHS);
1685           RI->copyFastMathFlags(BO);
1686           return RI;
1687         }
1688         break;
1689       case Instruction::FMul:
1690         // For multiplication, the infinitely precise result has at most
1691         // LHSWidth + RHSWidth significant bits; if OpWidth is sufficient
1692         // that such a value can be exactly represented, then no double
1693         // rounding can possibly occur; we can safely perform the operation
1694         // in the destination format if it can represent both sources.
1695         if (OpWidth >= LHSWidth + RHSWidth && DstWidth >= SrcWidth) {
1696           Value *LHS = Builder.CreateFPTrunc(BO->getOperand(0), Ty);
1697           Value *RHS = Builder.CreateFPTrunc(BO->getOperand(1), Ty);
1698           return BinaryOperator::CreateFMulFMF(LHS, RHS, BO);
1699         }
1700         break;
1701       case Instruction::FDiv:
1702         // For division, we use again use the bound from Figueroa's
1703         // dissertation.  I am entirely certain that this bound can be
1704         // tightened in the unbalanced operand case by an analysis based on
1705         // the diophantine rational approximation bound, but the well-known
1706         // condition used here is a good conservative first pass.
1707         // TODO: Tighten bound via rigorous analysis of the unbalanced case.
1708         if (OpWidth >= 2*DstWidth && DstWidth >= SrcWidth) {
1709           Value *LHS = Builder.CreateFPTrunc(BO->getOperand(0), Ty);
1710           Value *RHS = Builder.CreateFPTrunc(BO->getOperand(1), Ty);
1711           return BinaryOperator::CreateFDivFMF(LHS, RHS, BO);
1712         }
1713         break;
1714       case Instruction::FRem: {
1715         // Remainder is straightforward.  Remainder is always exact, so the
1716         // type of OpI doesn't enter into things at all.  We simply evaluate
1717         // in whichever source type is larger, then convert to the
1718         // destination type.
1719         if (SrcWidth == OpWidth)
1720           break;
1721         Value *LHS, *RHS;
1722         if (LHSWidth == SrcWidth) {
1723            LHS = Builder.CreateFPTrunc(BO->getOperand(0), LHSMinType);
1724            RHS = Builder.CreateFPTrunc(BO->getOperand(1), LHSMinType);
1725         } else {
1726            LHS = Builder.CreateFPTrunc(BO->getOperand(0), RHSMinType);
1727            RHS = Builder.CreateFPTrunc(BO->getOperand(1), RHSMinType);
1728         }
1729 
1730         Value *ExactResult = Builder.CreateFRemFMF(LHS, RHS, BO);
1731         return CastInst::CreateFPCast(ExactResult, Ty);
1732       }
1733     }
1734   }
1735 
1736   // (fptrunc (fneg x)) -> (fneg (fptrunc x))
1737   Value *X;
1738   Instruction *Op = dyn_cast<Instruction>(FPT.getOperand(0));
1739   if (Op && Op->hasOneUse()) {
1740     // FIXME: The FMF should propagate from the fptrunc, not the source op.
1741     IRBuilder<>::FastMathFlagGuard FMFG(Builder);
1742     if (isa<FPMathOperator>(Op))
1743       Builder.setFastMathFlags(Op->getFastMathFlags());
1744 
1745     if (match(Op, m_FNeg(m_Value(X)))) {
1746       Value *InnerTrunc = Builder.CreateFPTrunc(X, Ty);
1747 
1748       return UnaryOperator::CreateFNegFMF(InnerTrunc, Op);
1749     }
1750 
1751     // If we are truncating a select that has an extended operand, we can
1752     // narrow the other operand and do the select as a narrow op.
1753     Value *Cond, *X, *Y;
1754     if (match(Op, m_Select(m_Value(Cond), m_FPExt(m_Value(X)), m_Value(Y))) &&
1755         X->getType() == Ty) {
1756       // fptrunc (select Cond, (fpext X), Y --> select Cond, X, (fptrunc Y)
1757       Value *NarrowY = Builder.CreateFPTrunc(Y, Ty);
1758       Value *Sel = Builder.CreateSelect(Cond, X, NarrowY, "narrow.sel", Op);
1759       return replaceInstUsesWith(FPT, Sel);
1760     }
1761     if (match(Op, m_Select(m_Value(Cond), m_Value(Y), m_FPExt(m_Value(X)))) &&
1762         X->getType() == Ty) {
1763       // fptrunc (select Cond, Y, (fpext X) --> select Cond, (fptrunc Y), X
1764       Value *NarrowY = Builder.CreateFPTrunc(Y, Ty);
1765       Value *Sel = Builder.CreateSelect(Cond, NarrowY, X, "narrow.sel", Op);
1766       return replaceInstUsesWith(FPT, Sel);
1767     }
1768   }
1769 
1770   if (auto *II = dyn_cast<IntrinsicInst>(FPT.getOperand(0))) {
1771     switch (II->getIntrinsicID()) {
1772     default: break;
1773     case Intrinsic::ceil:
1774     case Intrinsic::fabs:
1775     case Intrinsic::floor:
1776     case Intrinsic::nearbyint:
1777     case Intrinsic::rint:
1778     case Intrinsic::round:
1779     case Intrinsic::roundeven:
1780     case Intrinsic::trunc: {
1781       Value *Src = II->getArgOperand(0);
1782       if (!Src->hasOneUse())
1783         break;
1784 
1785       // Except for fabs, this transformation requires the input of the unary FP
1786       // operation to be itself an fpext from the type to which we're
1787       // truncating.
1788       if (II->getIntrinsicID() != Intrinsic::fabs) {
1789         FPExtInst *FPExtSrc = dyn_cast<FPExtInst>(Src);
1790         if (!FPExtSrc || FPExtSrc->getSrcTy() != Ty)
1791           break;
1792       }
1793 
1794       // Do unary FP operation on smaller type.
1795       // (fptrunc (fabs x)) -> (fabs (fptrunc x))
1796       Value *InnerTrunc = Builder.CreateFPTrunc(Src, Ty);
1797       Function *Overload = Intrinsic::getDeclaration(FPT.getModule(),
1798                                                      II->getIntrinsicID(), Ty);
1799       SmallVector<OperandBundleDef, 1> OpBundles;
1800       II->getOperandBundlesAsDefs(OpBundles);
1801       CallInst *NewCI =
1802           CallInst::Create(Overload, {InnerTrunc}, OpBundles, II->getName());
1803       NewCI->copyFastMathFlags(II);
1804       return NewCI;
1805     }
1806     }
1807   }
1808 
1809   if (Instruction *I = shrinkInsertElt(FPT, Builder))
1810     return I;
1811 
1812   Value *Src = FPT.getOperand(0);
1813   if (isa<SIToFPInst>(Src) || isa<UIToFPInst>(Src)) {
1814     auto *FPCast = cast<CastInst>(Src);
1815     if (isKnownExactCastIntToFP(*FPCast))
1816       return CastInst::Create(FPCast->getOpcode(), FPCast->getOperand(0), Ty);
1817   }
1818 
1819   return nullptr;
1820 }
1821 
1822 Instruction *InstCombinerImpl::visitFPExt(CastInst &FPExt) {
1823   // If the source operand is a cast from integer to FP and known exact, then
1824   // cast the integer operand directly to the destination type.
1825   Type *Ty = FPExt.getType();
1826   Value *Src = FPExt.getOperand(0);
1827   if (isa<SIToFPInst>(Src) || isa<UIToFPInst>(Src)) {
1828     auto *FPCast = cast<CastInst>(Src);
1829     if (isKnownExactCastIntToFP(*FPCast))
1830       return CastInst::Create(FPCast->getOpcode(), FPCast->getOperand(0), Ty);
1831   }
1832 
1833   return commonCastTransforms(FPExt);
1834 }
1835 
1836 /// fpto{s/u}i({u/s}itofp(X)) --> X or zext(X) or sext(X) or trunc(X)
1837 /// This is safe if the intermediate type has enough bits in its mantissa to
1838 /// accurately represent all values of X.  For example, this won't work with
1839 /// i64 -> float -> i64.
1840 Instruction *InstCombinerImpl::foldItoFPtoI(CastInst &FI) {
1841   if (!isa<UIToFPInst>(FI.getOperand(0)) && !isa<SIToFPInst>(FI.getOperand(0)))
1842     return nullptr;
1843 
1844   auto *OpI = cast<CastInst>(FI.getOperand(0));
1845   Value *X = OpI->getOperand(0);
1846   Type *XType = X->getType();
1847   Type *DestType = FI.getType();
1848   bool IsOutputSigned = isa<FPToSIInst>(FI);
1849 
1850   // Since we can assume the conversion won't overflow, our decision as to
1851   // whether the input will fit in the float should depend on the minimum
1852   // of the input range and output range.
1853 
1854   // This means this is also safe for a signed input and unsigned output, since
1855   // a negative input would lead to undefined behavior.
1856   if (!isKnownExactCastIntToFP(*OpI)) {
1857     // The first cast may not round exactly based on the source integer width
1858     // and FP width, but the overflow UB rules can still allow this to fold.
1859     // If the destination type is narrow, that means the intermediate FP value
1860     // must be large enough to hold the source value exactly.
1861     // For example, (uint8_t)((float)(uint32_t 16777217) is undefined behavior.
1862     int OutputSize = (int)DestType->getScalarSizeInBits() - IsOutputSigned;
1863     if (OutputSize > OpI->getType()->getFPMantissaWidth())
1864       return nullptr;
1865   }
1866 
1867   if (DestType->getScalarSizeInBits() > XType->getScalarSizeInBits()) {
1868     bool IsInputSigned = isa<SIToFPInst>(OpI);
1869     if (IsInputSigned && IsOutputSigned)
1870       return new SExtInst(X, DestType);
1871     return new ZExtInst(X, DestType);
1872   }
1873   if (DestType->getScalarSizeInBits() < XType->getScalarSizeInBits())
1874     return new TruncInst(X, DestType);
1875 
1876   assert(XType == DestType && "Unexpected types for int to FP to int casts");
1877   return replaceInstUsesWith(FI, X);
1878 }
1879 
1880 Instruction *InstCombinerImpl::visitFPToUI(FPToUIInst &FI) {
1881   if (Instruction *I = foldItoFPtoI(FI))
1882     return I;
1883 
1884   return commonCastTransforms(FI);
1885 }
1886 
1887 Instruction *InstCombinerImpl::visitFPToSI(FPToSIInst &FI) {
1888   if (Instruction *I = foldItoFPtoI(FI))
1889     return I;
1890 
1891   return commonCastTransforms(FI);
1892 }
1893 
1894 Instruction *InstCombinerImpl::visitUIToFP(CastInst &CI) {
1895   return commonCastTransforms(CI);
1896 }
1897 
1898 Instruction *InstCombinerImpl::visitSIToFP(CastInst &CI) {
1899   return commonCastTransforms(CI);
1900 }
1901 
1902 Instruction *InstCombinerImpl::visitIntToPtr(IntToPtrInst &CI) {
1903   // If the source integer type is not the intptr_t type for this target, do a
1904   // trunc or zext to the intptr_t type, then inttoptr of it.  This allows the
1905   // cast to be exposed to other transforms.
1906   unsigned AS = CI.getAddressSpace();
1907   if (CI.getOperand(0)->getType()->getScalarSizeInBits() !=
1908       DL.getPointerSizeInBits(AS)) {
1909     Type *Ty = DL.getIntPtrType(CI.getContext(), AS);
1910     // Handle vectors of pointers.
1911     if (auto *CIVTy = dyn_cast<VectorType>(CI.getType()))
1912       Ty = VectorType::get(Ty, CIVTy->getElementCount());
1913 
1914     Value *P = Builder.CreateZExtOrTrunc(CI.getOperand(0), Ty);
1915     return new IntToPtrInst(P, CI.getType());
1916   }
1917 
1918   if (Instruction *I = commonCastTransforms(CI))
1919     return I;
1920 
1921   return nullptr;
1922 }
1923 
1924 /// Implement the transforms for cast of pointer (bitcast/ptrtoint)
1925 Instruction *InstCombinerImpl::commonPointerCastTransforms(CastInst &CI) {
1926   Value *Src = CI.getOperand(0);
1927 
1928   if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Src)) {
1929     // If casting the result of a getelementptr instruction with no offset, turn
1930     // this into a cast of the original pointer!
1931     if (GEP->hasAllZeroIndices() &&
1932         // If CI is an addrspacecast and GEP changes the poiner type, merging
1933         // GEP into CI would undo canonicalizing addrspacecast with different
1934         // pointer types, causing infinite loops.
1935         (!isa<AddrSpaceCastInst>(CI) ||
1936          GEP->getType() == GEP->getPointerOperandType())) {
1937       // Changing the cast operand is usually not a good idea but it is safe
1938       // here because the pointer operand is being replaced with another
1939       // pointer operand so the opcode doesn't need to change.
1940       return replaceOperand(CI, 0, GEP->getOperand(0));
1941     }
1942   }
1943 
1944   return commonCastTransforms(CI);
1945 }
1946 
1947 Instruction *InstCombinerImpl::visitPtrToInt(PtrToIntInst &CI) {
1948   // If the destination integer type is not the intptr_t type for this target,
1949   // do a ptrtoint to intptr_t then do a trunc or zext.  This allows the cast
1950   // to be exposed to other transforms.
1951   Value *SrcOp = CI.getPointerOperand();
1952   Type *Ty = CI.getType();
1953   unsigned AS = CI.getPointerAddressSpace();
1954   unsigned TySize = Ty->getScalarSizeInBits();
1955   unsigned PtrSize = DL.getPointerSizeInBits(AS);
1956   if (TySize != PtrSize) {
1957     Type *IntPtrTy = DL.getIntPtrType(CI.getContext(), AS);
1958     if (auto *VecTy = dyn_cast<VectorType>(Ty)) {
1959       // Handle vectors of pointers.
1960       // FIXME: what should happen for scalable vectors?
1961       IntPtrTy = FixedVectorType::get(
1962           IntPtrTy, cast<FixedVectorType>(VecTy)->getNumElements());
1963     }
1964 
1965     Value *P = Builder.CreatePtrToInt(SrcOp, IntPtrTy);
1966     return CastInst::CreateIntegerCast(P, Ty, /*isSigned=*/false);
1967   }
1968 
1969   Value *Vec, *Scalar, *Index;
1970   if (match(SrcOp, m_OneUse(m_InsertElt(m_IntToPtr(m_Value(Vec)),
1971                                         m_Value(Scalar), m_Value(Index)))) &&
1972       Vec->getType() == Ty) {
1973     assert(Vec->getType()->getScalarSizeInBits() == PtrSize && "Wrong type");
1974     // Convert the scalar to int followed by insert to eliminate one cast:
1975     // p2i (ins (i2p Vec), Scalar, Index --> ins Vec, (p2i Scalar), Index
1976     Value *NewCast = Builder.CreatePtrToInt(Scalar, Ty->getScalarType());
1977     return InsertElementInst::Create(Vec, NewCast, Index);
1978   }
1979 
1980   return commonPointerCastTransforms(CI);
1981 }
1982 
1983 /// This input value (which is known to have vector type) is being zero extended
1984 /// or truncated to the specified vector type. Since the zext/trunc is done
1985 /// using an integer type, we have a (bitcast(cast(bitcast))) pattern,
1986 /// endianness will impact which end of the vector that is extended or
1987 /// truncated.
1988 ///
1989 /// A vector is always stored with index 0 at the lowest address, which
1990 /// corresponds to the most significant bits for a big endian stored integer and
1991 /// the least significant bits for little endian. A trunc/zext of an integer
1992 /// impacts the big end of the integer. Thus, we need to add/remove elements at
1993 /// the front of the vector for big endian targets, and the back of the vector
1994 /// for little endian targets.
1995 ///
1996 /// Try to replace it with a shuffle (and vector/vector bitcast) if possible.
1997 ///
1998 /// The source and destination vector types may have different element types.
1999 static Instruction *
2000 optimizeVectorResizeWithIntegerBitCasts(Value *InVal, VectorType *DestTy,
2001                                         InstCombinerImpl &IC) {
2002   // We can only do this optimization if the output is a multiple of the input
2003   // element size, or the input is a multiple of the output element size.
2004   // Convert the input type to have the same element type as the output.
2005   VectorType *SrcTy = cast<VectorType>(InVal->getType());
2006 
2007   if (SrcTy->getElementType() != DestTy->getElementType()) {
2008     // The input types don't need to be identical, but for now they must be the
2009     // same size.  There is no specific reason we couldn't handle things like
2010     // <4 x i16> -> <4 x i32> by bitcasting to <2 x i32> but haven't gotten
2011     // there yet.
2012     if (SrcTy->getElementType()->getPrimitiveSizeInBits() !=
2013         DestTy->getElementType()->getPrimitiveSizeInBits())
2014       return nullptr;
2015 
2016     SrcTy =
2017         FixedVectorType::get(DestTy->getElementType(),
2018                              cast<FixedVectorType>(SrcTy)->getNumElements());
2019     InVal = IC.Builder.CreateBitCast(InVal, SrcTy);
2020   }
2021 
2022   bool IsBigEndian = IC.getDataLayout().isBigEndian();
2023   unsigned SrcElts = cast<FixedVectorType>(SrcTy)->getNumElements();
2024   unsigned DestElts = cast<FixedVectorType>(DestTy)->getNumElements();
2025 
2026   assert(SrcElts != DestElts && "Element counts should be different.");
2027 
2028   // Now that the element types match, get the shuffle mask and RHS of the
2029   // shuffle to use, which depends on whether we're increasing or decreasing the
2030   // size of the input.
2031   SmallVector<int, 16> ShuffleMaskStorage;
2032   ArrayRef<int> ShuffleMask;
2033   Value *V2;
2034 
2035   // Produce an identify shuffle mask for the src vector.
2036   ShuffleMaskStorage.resize(SrcElts);
2037   std::iota(ShuffleMaskStorage.begin(), ShuffleMaskStorage.end(), 0);
2038 
2039   if (SrcElts > DestElts) {
2040     // If we're shrinking the number of elements (rewriting an integer
2041     // truncate), just shuffle in the elements corresponding to the least
2042     // significant bits from the input and use undef as the second shuffle
2043     // input.
2044     V2 = UndefValue::get(SrcTy);
2045     // Make sure the shuffle mask selects the "least significant bits" by
2046     // keeping elements from back of the src vector for big endian, and from the
2047     // front for little endian.
2048     ShuffleMask = ShuffleMaskStorage;
2049     if (IsBigEndian)
2050       ShuffleMask = ShuffleMask.take_back(DestElts);
2051     else
2052       ShuffleMask = ShuffleMask.take_front(DestElts);
2053   } else {
2054     // If we're increasing the number of elements (rewriting an integer zext),
2055     // shuffle in all of the elements from InVal. Fill the rest of the result
2056     // elements with zeros from a constant zero.
2057     V2 = Constant::getNullValue(SrcTy);
2058     // Use first elt from V2 when indicating zero in the shuffle mask.
2059     uint32_t NullElt = SrcElts;
2060     // Extend with null values in the "most significant bits" by adding elements
2061     // in front of the src vector for big endian, and at the back for little
2062     // endian.
2063     unsigned DeltaElts = DestElts - SrcElts;
2064     if (IsBigEndian)
2065       ShuffleMaskStorage.insert(ShuffleMaskStorage.begin(), DeltaElts, NullElt);
2066     else
2067       ShuffleMaskStorage.append(DeltaElts, NullElt);
2068     ShuffleMask = ShuffleMaskStorage;
2069   }
2070 
2071   return new ShuffleVectorInst(InVal, V2, ShuffleMask);
2072 }
2073 
2074 static bool isMultipleOfTypeSize(unsigned Value, Type *Ty) {
2075   return Value % Ty->getPrimitiveSizeInBits() == 0;
2076 }
2077 
2078 static unsigned getTypeSizeIndex(unsigned Value, Type *Ty) {
2079   return Value / Ty->getPrimitiveSizeInBits();
2080 }
2081 
2082 /// V is a value which is inserted into a vector of VecEltTy.
2083 /// Look through the value to see if we can decompose it into
2084 /// insertions into the vector.  See the example in the comment for
2085 /// OptimizeIntegerToVectorInsertions for the pattern this handles.
2086 /// The type of V is always a non-zero multiple of VecEltTy's size.
2087 /// Shift is the number of bits between the lsb of V and the lsb of
2088 /// the vector.
2089 ///
2090 /// This returns false if the pattern can't be matched or true if it can,
2091 /// filling in Elements with the elements found here.
2092 static bool collectInsertionElements(Value *V, unsigned Shift,
2093                                      SmallVectorImpl<Value *> &Elements,
2094                                      Type *VecEltTy, bool isBigEndian) {
2095   assert(isMultipleOfTypeSize(Shift, VecEltTy) &&
2096          "Shift should be a multiple of the element type size");
2097 
2098   // Undef values never contribute useful bits to the result.
2099   if (isa<UndefValue>(V)) return true;
2100 
2101   // If we got down to a value of the right type, we win, try inserting into the
2102   // right element.
2103   if (V->getType() == VecEltTy) {
2104     // Inserting null doesn't actually insert any elements.
2105     if (Constant *C = dyn_cast<Constant>(V))
2106       if (C->isNullValue())
2107         return true;
2108 
2109     unsigned ElementIndex = getTypeSizeIndex(Shift, VecEltTy);
2110     if (isBigEndian)
2111       ElementIndex = Elements.size() - ElementIndex - 1;
2112 
2113     // Fail if multiple elements are inserted into this slot.
2114     if (Elements[ElementIndex])
2115       return false;
2116 
2117     Elements[ElementIndex] = V;
2118     return true;
2119   }
2120 
2121   if (Constant *C = dyn_cast<Constant>(V)) {
2122     // Figure out the # elements this provides, and bitcast it or slice it up
2123     // as required.
2124     unsigned NumElts = getTypeSizeIndex(C->getType()->getPrimitiveSizeInBits(),
2125                                         VecEltTy);
2126     // If the constant is the size of a vector element, we just need to bitcast
2127     // it to the right type so it gets properly inserted.
2128     if (NumElts == 1)
2129       return collectInsertionElements(ConstantExpr::getBitCast(C, VecEltTy),
2130                                       Shift, Elements, VecEltTy, isBigEndian);
2131 
2132     // Okay, this is a constant that covers multiple elements.  Slice it up into
2133     // pieces and insert each element-sized piece into the vector.
2134     if (!isa<IntegerType>(C->getType()))
2135       C = ConstantExpr::getBitCast(C, IntegerType::get(V->getContext(),
2136                                        C->getType()->getPrimitiveSizeInBits()));
2137     unsigned ElementSize = VecEltTy->getPrimitiveSizeInBits();
2138     Type *ElementIntTy = IntegerType::get(C->getContext(), ElementSize);
2139 
2140     for (unsigned i = 0; i != NumElts; ++i) {
2141       unsigned ShiftI = Shift+i*ElementSize;
2142       Constant *Piece = ConstantExpr::getLShr(C, ConstantInt::get(C->getType(),
2143                                                                   ShiftI));
2144       Piece = ConstantExpr::getTrunc(Piece, ElementIntTy);
2145       if (!collectInsertionElements(Piece, ShiftI, Elements, VecEltTy,
2146                                     isBigEndian))
2147         return false;
2148     }
2149     return true;
2150   }
2151 
2152   if (!V->hasOneUse()) return false;
2153 
2154   Instruction *I = dyn_cast<Instruction>(V);
2155   if (!I) return false;
2156   switch (I->getOpcode()) {
2157   default: return false; // Unhandled case.
2158   case Instruction::BitCast:
2159     return collectInsertionElements(I->getOperand(0), Shift, Elements, VecEltTy,
2160                                     isBigEndian);
2161   case Instruction::ZExt:
2162     if (!isMultipleOfTypeSize(
2163                           I->getOperand(0)->getType()->getPrimitiveSizeInBits(),
2164                               VecEltTy))
2165       return false;
2166     return collectInsertionElements(I->getOperand(0), Shift, Elements, VecEltTy,
2167                                     isBigEndian);
2168   case Instruction::Or:
2169     return collectInsertionElements(I->getOperand(0), Shift, Elements, VecEltTy,
2170                                     isBigEndian) &&
2171            collectInsertionElements(I->getOperand(1), Shift, Elements, VecEltTy,
2172                                     isBigEndian);
2173   case Instruction::Shl: {
2174     // Must be shifting by a constant that is a multiple of the element size.
2175     ConstantInt *CI = dyn_cast<ConstantInt>(I->getOperand(1));
2176     if (!CI) return false;
2177     Shift += CI->getZExtValue();
2178     if (!isMultipleOfTypeSize(Shift, VecEltTy)) return false;
2179     return collectInsertionElements(I->getOperand(0), Shift, Elements, VecEltTy,
2180                                     isBigEndian);
2181   }
2182 
2183   }
2184 }
2185 
2186 
2187 /// If the input is an 'or' instruction, we may be doing shifts and ors to
2188 /// assemble the elements of the vector manually.
2189 /// Try to rip the code out and replace it with insertelements.  This is to
2190 /// optimize code like this:
2191 ///
2192 ///    %tmp37 = bitcast float %inc to i32
2193 ///    %tmp38 = zext i32 %tmp37 to i64
2194 ///    %tmp31 = bitcast float %inc5 to i32
2195 ///    %tmp32 = zext i32 %tmp31 to i64
2196 ///    %tmp33 = shl i64 %tmp32, 32
2197 ///    %ins35 = or i64 %tmp33, %tmp38
2198 ///    %tmp43 = bitcast i64 %ins35 to <2 x float>
2199 ///
2200 /// Into two insertelements that do "buildvector{%inc, %inc5}".
2201 static Value *optimizeIntegerToVectorInsertions(BitCastInst &CI,
2202                                                 InstCombinerImpl &IC) {
2203   auto *DestVecTy = cast<FixedVectorType>(CI.getType());
2204   Value *IntInput = CI.getOperand(0);
2205 
2206   SmallVector<Value*, 8> Elements(DestVecTy->getNumElements());
2207   if (!collectInsertionElements(IntInput, 0, Elements,
2208                                 DestVecTy->getElementType(),
2209                                 IC.getDataLayout().isBigEndian()))
2210     return nullptr;
2211 
2212   // If we succeeded, we know that all of the element are specified by Elements
2213   // or are zero if Elements has a null entry.  Recast this as a set of
2214   // insertions.
2215   Value *Result = Constant::getNullValue(CI.getType());
2216   for (unsigned i = 0, e = Elements.size(); i != e; ++i) {
2217     if (!Elements[i]) continue;  // Unset element.
2218 
2219     Result = IC.Builder.CreateInsertElement(Result, Elements[i],
2220                                             IC.Builder.getInt32(i));
2221   }
2222 
2223   return Result;
2224 }
2225 
2226 /// Canonicalize scalar bitcasts of extracted elements into a bitcast of the
2227 /// vector followed by extract element. The backend tends to handle bitcasts of
2228 /// vectors better than bitcasts of scalars because vector registers are
2229 /// usually not type-specific like scalar integer or scalar floating-point.
2230 static Instruction *canonicalizeBitCastExtElt(BitCastInst &BitCast,
2231                                               InstCombinerImpl &IC) {
2232   // TODO: Create and use a pattern matcher for ExtractElementInst.
2233   auto *ExtElt = dyn_cast<ExtractElementInst>(BitCast.getOperand(0));
2234   if (!ExtElt || !ExtElt->hasOneUse())
2235     return nullptr;
2236 
2237   // The bitcast must be to a vectorizable type, otherwise we can't make a new
2238   // type to extract from.
2239   Type *DestType = BitCast.getType();
2240   if (!VectorType::isValidElementType(DestType))
2241     return nullptr;
2242 
2243   auto *NewVecType = VectorType::get(DestType, ExtElt->getVectorOperandType());
2244   auto *NewBC = IC.Builder.CreateBitCast(ExtElt->getVectorOperand(),
2245                                          NewVecType, "bc");
2246   return ExtractElementInst::Create(NewBC, ExtElt->getIndexOperand());
2247 }
2248 
2249 /// Change the type of a bitwise logic operation if we can eliminate a bitcast.
2250 static Instruction *foldBitCastBitwiseLogic(BitCastInst &BitCast,
2251                                             InstCombiner::BuilderTy &Builder) {
2252   Type *DestTy = BitCast.getType();
2253   BinaryOperator *BO;
2254   if (!DestTy->isIntOrIntVectorTy() ||
2255       !match(BitCast.getOperand(0), m_OneUse(m_BinOp(BO))) ||
2256       !BO->isBitwiseLogicOp())
2257     return nullptr;
2258 
2259   // FIXME: This transform is restricted to vector types to avoid backend
2260   // problems caused by creating potentially illegal operations. If a fix-up is
2261   // added to handle that situation, we can remove this check.
2262   if (!DestTy->isVectorTy() || !BO->getType()->isVectorTy())
2263     return nullptr;
2264 
2265   Value *X;
2266   if (match(BO->getOperand(0), m_OneUse(m_BitCast(m_Value(X)))) &&
2267       X->getType() == DestTy && !isa<Constant>(X)) {
2268     // bitcast(logic(bitcast(X), Y)) --> logic'(X, bitcast(Y))
2269     Value *CastedOp1 = Builder.CreateBitCast(BO->getOperand(1), DestTy);
2270     return BinaryOperator::Create(BO->getOpcode(), X, CastedOp1);
2271   }
2272 
2273   if (match(BO->getOperand(1), m_OneUse(m_BitCast(m_Value(X)))) &&
2274       X->getType() == DestTy && !isa<Constant>(X)) {
2275     // bitcast(logic(Y, bitcast(X))) --> logic'(bitcast(Y), X)
2276     Value *CastedOp0 = Builder.CreateBitCast(BO->getOperand(0), DestTy);
2277     return BinaryOperator::Create(BO->getOpcode(), CastedOp0, X);
2278   }
2279 
2280   // Canonicalize vector bitcasts to come before vector bitwise logic with a
2281   // constant. This eases recognition of special constants for later ops.
2282   // Example:
2283   // icmp u/s (a ^ signmask), (b ^ signmask) --> icmp s/u a, b
2284   Constant *C;
2285   if (match(BO->getOperand(1), m_Constant(C))) {
2286     // bitcast (logic X, C) --> logic (bitcast X, C')
2287     Value *CastedOp0 = Builder.CreateBitCast(BO->getOperand(0), DestTy);
2288     Value *CastedC = Builder.CreateBitCast(C, DestTy);
2289     return BinaryOperator::Create(BO->getOpcode(), CastedOp0, CastedC);
2290   }
2291 
2292   return nullptr;
2293 }
2294 
2295 /// Change the type of a select if we can eliminate a bitcast.
2296 static Instruction *foldBitCastSelect(BitCastInst &BitCast,
2297                                       InstCombiner::BuilderTy &Builder) {
2298   Value *Cond, *TVal, *FVal;
2299   if (!match(BitCast.getOperand(0),
2300              m_OneUse(m_Select(m_Value(Cond), m_Value(TVal), m_Value(FVal)))))
2301     return nullptr;
2302 
2303   // A vector select must maintain the same number of elements in its operands.
2304   Type *CondTy = Cond->getType();
2305   Type *DestTy = BitCast.getType();
2306   if (auto *CondVTy = dyn_cast<VectorType>(CondTy)) {
2307     if (!DestTy->isVectorTy())
2308       return nullptr;
2309     if (cast<FixedVectorType>(DestTy)->getNumElements() !=
2310         cast<FixedVectorType>(CondVTy)->getNumElements())
2311       return nullptr;
2312   }
2313 
2314   // FIXME: This transform is restricted from changing the select between
2315   // scalars and vectors to avoid backend problems caused by creating
2316   // potentially illegal operations. If a fix-up is added to handle that
2317   // situation, we can remove this check.
2318   if (DestTy->isVectorTy() != TVal->getType()->isVectorTy())
2319     return nullptr;
2320 
2321   auto *Sel = cast<Instruction>(BitCast.getOperand(0));
2322   Value *X;
2323   if (match(TVal, m_OneUse(m_BitCast(m_Value(X)))) && X->getType() == DestTy &&
2324       !isa<Constant>(X)) {
2325     // bitcast(select(Cond, bitcast(X), Y)) --> select'(Cond, X, bitcast(Y))
2326     Value *CastedVal = Builder.CreateBitCast(FVal, DestTy);
2327     return SelectInst::Create(Cond, X, CastedVal, "", nullptr, Sel);
2328   }
2329 
2330   if (match(FVal, m_OneUse(m_BitCast(m_Value(X)))) && X->getType() == DestTy &&
2331       !isa<Constant>(X)) {
2332     // bitcast(select(Cond, Y, bitcast(X))) --> select'(Cond, bitcast(Y), X)
2333     Value *CastedVal = Builder.CreateBitCast(TVal, DestTy);
2334     return SelectInst::Create(Cond, CastedVal, X, "", nullptr, Sel);
2335   }
2336 
2337   return nullptr;
2338 }
2339 
2340 /// Check if all users of CI are StoreInsts.
2341 static bool hasStoreUsersOnly(CastInst &CI) {
2342   for (User *U : CI.users()) {
2343     if (!isa<StoreInst>(U))
2344       return false;
2345   }
2346   return true;
2347 }
2348 
2349 /// This function handles following case
2350 ///
2351 ///     A  ->  B    cast
2352 ///     PHI
2353 ///     B  ->  A    cast
2354 ///
2355 /// All the related PHI nodes can be replaced by new PHI nodes with type A.
2356 /// The uses of \p CI can be changed to the new PHI node corresponding to \p PN.
2357 Instruction *InstCombinerImpl::optimizeBitCastFromPhi(CastInst &CI,
2358                                                       PHINode *PN) {
2359   // BitCast used by Store can be handled in InstCombineLoadStoreAlloca.cpp.
2360   if (hasStoreUsersOnly(CI))
2361     return nullptr;
2362 
2363   Value *Src = CI.getOperand(0);
2364   Type *SrcTy = Src->getType();         // Type B
2365   Type *DestTy = CI.getType();          // Type A
2366 
2367   SmallVector<PHINode *, 4> PhiWorklist;
2368   SmallSetVector<PHINode *, 4> OldPhiNodes;
2369 
2370   // Find all of the A->B casts and PHI nodes.
2371   // We need to inspect all related PHI nodes, but PHIs can be cyclic, so
2372   // OldPhiNodes is used to track all known PHI nodes, before adding a new
2373   // PHI to PhiWorklist, it is checked against and added to OldPhiNodes first.
2374   PhiWorklist.push_back(PN);
2375   OldPhiNodes.insert(PN);
2376   while (!PhiWorklist.empty()) {
2377     auto *OldPN = PhiWorklist.pop_back_val();
2378     for (Value *IncValue : OldPN->incoming_values()) {
2379       if (isa<Constant>(IncValue))
2380         continue;
2381 
2382       if (auto *LI = dyn_cast<LoadInst>(IncValue)) {
2383         // If there is a sequence of one or more load instructions, each loaded
2384         // value is used as address of later load instruction, bitcast is
2385         // necessary to change the value type, don't optimize it. For
2386         // simplicity we give up if the load address comes from another load.
2387         Value *Addr = LI->getOperand(0);
2388         if (Addr == &CI || isa<LoadInst>(Addr))
2389           return nullptr;
2390         if (LI->hasOneUse() && LI->isSimple())
2391           continue;
2392         // If a LoadInst has more than one use, changing the type of loaded
2393         // value may create another bitcast.
2394         return nullptr;
2395       }
2396 
2397       if (auto *PNode = dyn_cast<PHINode>(IncValue)) {
2398         if (OldPhiNodes.insert(PNode))
2399           PhiWorklist.push_back(PNode);
2400         continue;
2401       }
2402 
2403       auto *BCI = dyn_cast<BitCastInst>(IncValue);
2404       // We can't handle other instructions.
2405       if (!BCI)
2406         return nullptr;
2407 
2408       // Verify it's a A->B cast.
2409       Type *TyA = BCI->getOperand(0)->getType();
2410       Type *TyB = BCI->getType();
2411       if (TyA != DestTy || TyB != SrcTy)
2412         return nullptr;
2413     }
2414   }
2415 
2416   // Check that each user of each old PHI node is something that we can
2417   // rewrite, so that all of the old PHI nodes can be cleaned up afterwards.
2418   for (auto *OldPN : OldPhiNodes) {
2419     for (User *V : OldPN->users()) {
2420       if (auto *SI = dyn_cast<StoreInst>(V)) {
2421         if (!SI->isSimple() || SI->getOperand(0) != OldPN)
2422           return nullptr;
2423       } else if (auto *BCI = dyn_cast<BitCastInst>(V)) {
2424         // Verify it's a B->A cast.
2425         Type *TyB = BCI->getOperand(0)->getType();
2426         Type *TyA = BCI->getType();
2427         if (TyA != DestTy || TyB != SrcTy)
2428           return nullptr;
2429       } else if (auto *PHI = dyn_cast<PHINode>(V)) {
2430         // As long as the user is another old PHI node, then even if we don't
2431         // rewrite it, the PHI web we're considering won't have any users
2432         // outside itself, so it'll be dead.
2433         if (OldPhiNodes.count(PHI) == 0)
2434           return nullptr;
2435       } else {
2436         return nullptr;
2437       }
2438     }
2439   }
2440 
2441   // For each old PHI node, create a corresponding new PHI node with a type A.
2442   SmallDenseMap<PHINode *, PHINode *> NewPNodes;
2443   for (auto *OldPN : OldPhiNodes) {
2444     Builder.SetInsertPoint(OldPN);
2445     PHINode *NewPN = Builder.CreatePHI(DestTy, OldPN->getNumOperands());
2446     NewPNodes[OldPN] = NewPN;
2447   }
2448 
2449   // Fill in the operands of new PHI nodes.
2450   for (auto *OldPN : OldPhiNodes) {
2451     PHINode *NewPN = NewPNodes[OldPN];
2452     for (unsigned j = 0, e = OldPN->getNumOperands(); j != e; ++j) {
2453       Value *V = OldPN->getOperand(j);
2454       Value *NewV = nullptr;
2455       if (auto *C = dyn_cast<Constant>(V)) {
2456         NewV = ConstantExpr::getBitCast(C, DestTy);
2457       } else if (auto *LI = dyn_cast<LoadInst>(V)) {
2458         // Explicitly perform load combine to make sure no opposing transform
2459         // can remove the bitcast in the meantime and trigger an infinite loop.
2460         Builder.SetInsertPoint(LI);
2461         NewV = combineLoadToNewType(*LI, DestTy);
2462         // Remove the old load and its use in the old phi, which itself becomes
2463         // dead once the whole transform finishes.
2464         replaceInstUsesWith(*LI, UndefValue::get(LI->getType()));
2465         eraseInstFromFunction(*LI);
2466       } else if (auto *BCI = dyn_cast<BitCastInst>(V)) {
2467         NewV = BCI->getOperand(0);
2468       } else if (auto *PrevPN = dyn_cast<PHINode>(V)) {
2469         NewV = NewPNodes[PrevPN];
2470       }
2471       assert(NewV);
2472       NewPN->addIncoming(NewV, OldPN->getIncomingBlock(j));
2473     }
2474   }
2475 
2476   // Traverse all accumulated PHI nodes and process its users,
2477   // which are Stores and BitcCasts. Without this processing
2478   // NewPHI nodes could be replicated and could lead to extra
2479   // moves generated after DeSSA.
2480   // If there is a store with type B, change it to type A.
2481 
2482 
2483   // Replace users of BitCast B->A with NewPHI. These will help
2484   // later to get rid off a closure formed by OldPHI nodes.
2485   Instruction *RetVal = nullptr;
2486   for (auto *OldPN : OldPhiNodes) {
2487     PHINode *NewPN = NewPNodes[OldPN];
2488     for (auto It = OldPN->user_begin(), End = OldPN->user_end(); It != End; ) {
2489       User *V = *It;
2490       // We may remove this user, advance to avoid iterator invalidation.
2491       ++It;
2492       if (auto *SI = dyn_cast<StoreInst>(V)) {
2493         assert(SI->isSimple() && SI->getOperand(0) == OldPN);
2494         Builder.SetInsertPoint(SI);
2495         auto *NewBC =
2496           cast<BitCastInst>(Builder.CreateBitCast(NewPN, SrcTy));
2497         SI->setOperand(0, NewBC);
2498         Worklist.push(SI);
2499         assert(hasStoreUsersOnly(*NewBC));
2500       }
2501       else if (auto *BCI = dyn_cast<BitCastInst>(V)) {
2502         Type *TyB = BCI->getOperand(0)->getType();
2503         Type *TyA = BCI->getType();
2504         assert(TyA == DestTy && TyB == SrcTy);
2505         (void) TyA;
2506         (void) TyB;
2507         Instruction *I = replaceInstUsesWith(*BCI, NewPN);
2508         if (BCI == &CI)
2509           RetVal = I;
2510       } else if (auto *PHI = dyn_cast<PHINode>(V)) {
2511         assert(OldPhiNodes.count(PHI) > 0);
2512         (void) PHI;
2513       } else {
2514         llvm_unreachable("all uses should be handled");
2515       }
2516     }
2517   }
2518 
2519   return RetVal;
2520 }
2521 
2522 Instruction *InstCombinerImpl::visitBitCast(BitCastInst &CI) {
2523   // If the operands are integer typed then apply the integer transforms,
2524   // otherwise just apply the common ones.
2525   Value *Src = CI.getOperand(0);
2526   Type *SrcTy = Src->getType();
2527   Type *DestTy = CI.getType();
2528 
2529   // Get rid of casts from one type to the same type. These are useless and can
2530   // be replaced by the operand.
2531   if (DestTy == Src->getType())
2532     return replaceInstUsesWith(CI, Src);
2533 
2534   if (isa<PointerType>(SrcTy) && isa<PointerType>(DestTy)) {
2535     PointerType *SrcPTy = cast<PointerType>(SrcTy);
2536     PointerType *DstPTy = cast<PointerType>(DestTy);
2537     Type *DstElTy = DstPTy->getElementType();
2538     Type *SrcElTy = SrcPTy->getElementType();
2539 
2540     // Casting pointers between the same type, but with different address spaces
2541     // is an addrspace cast rather than a bitcast.
2542     if ((DstElTy == SrcElTy) &&
2543         (DstPTy->getAddressSpace() != SrcPTy->getAddressSpace()))
2544       return new AddrSpaceCastInst(Src, DestTy);
2545 
2546     // If we are casting a alloca to a pointer to a type of the same
2547     // size, rewrite the allocation instruction to allocate the "right" type.
2548     // There is no need to modify malloc calls because it is their bitcast that
2549     // needs to be cleaned up.
2550     if (AllocaInst *AI = dyn_cast<AllocaInst>(Src))
2551       if (Instruction *V = PromoteCastOfAllocation(CI, *AI))
2552         return V;
2553 
2554     // When the type pointed to is not sized the cast cannot be
2555     // turned into a gep.
2556     Type *PointeeType =
2557         cast<PointerType>(Src->getType()->getScalarType())->getElementType();
2558     if (!PointeeType->isSized())
2559       return nullptr;
2560 
2561     // If the source and destination are pointers, and this cast is equivalent
2562     // to a getelementptr X, 0, 0, 0...  turn it into the appropriate gep.
2563     // This can enhance SROA and other transforms that want type-safe pointers.
2564     unsigned NumZeros = 0;
2565     while (SrcElTy && SrcElTy != DstElTy) {
2566       SrcElTy = GetElementPtrInst::getTypeAtIndex(SrcElTy, (uint64_t)0);
2567       ++NumZeros;
2568     }
2569 
2570     // If we found a path from the src to dest, create the getelementptr now.
2571     if (SrcElTy == DstElTy) {
2572       SmallVector<Value *, 8> Idxs(NumZeros + 1, Builder.getInt32(0));
2573       GetElementPtrInst *GEP =
2574           GetElementPtrInst::Create(SrcPTy->getElementType(), Src, Idxs);
2575 
2576       // If the source pointer is dereferenceable, then assume it points to an
2577       // allocated object and apply "inbounds" to the GEP.
2578       bool CanBeNull;
2579       if (Src->getPointerDereferenceableBytes(DL, CanBeNull)) {
2580         // In a non-default address space (not 0), a null pointer can not be
2581         // assumed inbounds, so ignore that case (dereferenceable_or_null).
2582         // The reason is that 'null' is not treated differently in these address
2583         // spaces, and we consequently ignore the 'gep inbounds' special case
2584         // for 'null' which allows 'inbounds' on 'null' if the indices are
2585         // zeros.
2586         if (SrcPTy->getAddressSpace() == 0 || !CanBeNull)
2587           GEP->setIsInBounds();
2588       }
2589       return GEP;
2590     }
2591   }
2592 
2593   if (FixedVectorType *DestVTy = dyn_cast<FixedVectorType>(DestTy)) {
2594     // Beware: messing with this target-specific oddity may cause trouble.
2595     if (DestVTy->getNumElements() == 1 && SrcTy->isX86_MMXTy()) {
2596       Value *Elem = Builder.CreateBitCast(Src, DestVTy->getElementType());
2597       return InsertElementInst::Create(UndefValue::get(DestTy), Elem,
2598                      Constant::getNullValue(Type::getInt32Ty(CI.getContext())));
2599     }
2600 
2601     if (isa<IntegerType>(SrcTy)) {
2602       // If this is a cast from an integer to vector, check to see if the input
2603       // is a trunc or zext of a bitcast from vector.  If so, we can replace all
2604       // the casts with a shuffle and (potentially) a bitcast.
2605       if (isa<TruncInst>(Src) || isa<ZExtInst>(Src)) {
2606         CastInst *SrcCast = cast<CastInst>(Src);
2607         if (BitCastInst *BCIn = dyn_cast<BitCastInst>(SrcCast->getOperand(0)))
2608           if (isa<VectorType>(BCIn->getOperand(0)->getType()))
2609             if (Instruction *I = optimizeVectorResizeWithIntegerBitCasts(
2610                     BCIn->getOperand(0), cast<VectorType>(DestTy), *this))
2611               return I;
2612       }
2613 
2614       // If the input is an 'or' instruction, we may be doing shifts and ors to
2615       // assemble the elements of the vector manually.  Try to rip the code out
2616       // and replace it with insertelements.
2617       if (Value *V = optimizeIntegerToVectorInsertions(CI, *this))
2618         return replaceInstUsesWith(CI, V);
2619     }
2620   }
2621 
2622   if (FixedVectorType *SrcVTy = dyn_cast<FixedVectorType>(SrcTy)) {
2623     if (SrcVTy->getNumElements() == 1) {
2624       // If our destination is not a vector, then make this a straight
2625       // scalar-scalar cast.
2626       if (!DestTy->isVectorTy()) {
2627         Value *Elem =
2628           Builder.CreateExtractElement(Src,
2629                      Constant::getNullValue(Type::getInt32Ty(CI.getContext())));
2630         return CastInst::Create(Instruction::BitCast, Elem, DestTy);
2631       }
2632 
2633       // Otherwise, see if our source is an insert. If so, then use the scalar
2634       // component directly:
2635       // bitcast (inselt <1 x elt> V, X, 0) to <n x m> --> bitcast X to <n x m>
2636       if (auto *InsElt = dyn_cast<InsertElementInst>(Src))
2637         return new BitCastInst(InsElt->getOperand(1), DestTy);
2638     }
2639   }
2640 
2641   if (auto *Shuf = dyn_cast<ShuffleVectorInst>(Src)) {
2642     // Okay, we have (bitcast (shuffle ..)).  Check to see if this is
2643     // a bitcast to a vector with the same # elts.
2644     Value *ShufOp0 = Shuf->getOperand(0);
2645     Value *ShufOp1 = Shuf->getOperand(1);
2646     unsigned NumShufElts =
2647         cast<FixedVectorType>(Shuf->getType())->getNumElements();
2648     unsigned NumSrcVecElts =
2649         cast<FixedVectorType>(ShufOp0->getType())->getNumElements();
2650     if (Shuf->hasOneUse() && DestTy->isVectorTy() &&
2651         cast<FixedVectorType>(DestTy)->getNumElements() == NumShufElts &&
2652         NumShufElts == NumSrcVecElts) {
2653       BitCastInst *Tmp;
2654       // If either of the operands is a cast from CI.getType(), then
2655       // evaluating the shuffle in the casted destination's type will allow
2656       // us to eliminate at least one cast.
2657       if (((Tmp = dyn_cast<BitCastInst>(ShufOp0)) &&
2658            Tmp->getOperand(0)->getType() == DestTy) ||
2659           ((Tmp = dyn_cast<BitCastInst>(ShufOp1)) &&
2660            Tmp->getOperand(0)->getType() == DestTy)) {
2661         Value *LHS = Builder.CreateBitCast(ShufOp0, DestTy);
2662         Value *RHS = Builder.CreateBitCast(ShufOp1, DestTy);
2663         // Return a new shuffle vector.  Use the same element ID's, as we
2664         // know the vector types match #elts.
2665         return new ShuffleVectorInst(LHS, RHS, Shuf->getShuffleMask());
2666       }
2667     }
2668 
2669     // A bitcasted-to-scalar and byte-reversing shuffle is better recognized as
2670     // a byte-swap:
2671     // bitcast <N x i8> (shuf X, undef, <N, N-1,...0>) --> bswap (bitcast X)
2672     // TODO: We should match the related pattern for bitreverse.
2673     if (DestTy->isIntegerTy() &&
2674         DL.isLegalInteger(DestTy->getScalarSizeInBits()) &&
2675         SrcTy->getScalarSizeInBits() == 8 && NumShufElts % 2 == 0 &&
2676         Shuf->hasOneUse() && Shuf->isReverse()) {
2677       assert(ShufOp0->getType() == SrcTy && "Unexpected shuffle mask");
2678       assert(isa<UndefValue>(ShufOp1) && "Unexpected shuffle op");
2679       Function *Bswap =
2680           Intrinsic::getDeclaration(CI.getModule(), Intrinsic::bswap, DestTy);
2681       Value *ScalarX = Builder.CreateBitCast(ShufOp0, DestTy);
2682       return IntrinsicInst::Create(Bswap, { ScalarX });
2683     }
2684   }
2685 
2686   // Handle the A->B->A cast, and there is an intervening PHI node.
2687   if (PHINode *PN = dyn_cast<PHINode>(Src))
2688     if (Instruction *I = optimizeBitCastFromPhi(CI, PN))
2689       return I;
2690 
2691   if (Instruction *I = canonicalizeBitCastExtElt(CI, *this))
2692     return I;
2693 
2694   if (Instruction *I = foldBitCastBitwiseLogic(CI, Builder))
2695     return I;
2696 
2697   if (Instruction *I = foldBitCastSelect(CI, Builder))
2698     return I;
2699 
2700   if (SrcTy->isPointerTy())
2701     return commonPointerCastTransforms(CI);
2702   return commonCastTransforms(CI);
2703 }
2704 
2705 Instruction *InstCombinerImpl::visitAddrSpaceCast(AddrSpaceCastInst &CI) {
2706   // If the destination pointer element type is not the same as the source's
2707   // first do a bitcast to the destination type, and then the addrspacecast.
2708   // This allows the cast to be exposed to other transforms.
2709   Value *Src = CI.getOperand(0);
2710   PointerType *SrcTy = cast<PointerType>(Src->getType()->getScalarType());
2711   PointerType *DestTy = cast<PointerType>(CI.getType()->getScalarType());
2712 
2713   Type *DestElemTy = DestTy->getElementType();
2714   if (SrcTy->getElementType() != DestElemTy) {
2715     Type *MidTy = PointerType::get(DestElemTy, SrcTy->getAddressSpace());
2716     if (VectorType *VT = dyn_cast<VectorType>(CI.getType())) {
2717       // Handle vectors of pointers.
2718       // FIXME: what should happen for scalable vectors?
2719       MidTy = FixedVectorType::get(MidTy,
2720                                    cast<FixedVectorType>(VT)->getNumElements());
2721     }
2722 
2723     Value *NewBitCast = Builder.CreateBitCast(Src, MidTy);
2724     return new AddrSpaceCastInst(NewBitCast, CI.getType());
2725   }
2726 
2727   return commonPointerCastTransforms(CI);
2728 }
2729