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