1 //===- InstCombineVectorOps.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 instcombine for ExtractElement, InsertElement and 10 // ShuffleVector. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "InstCombineInternal.h" 15 #include "llvm/ADT/APInt.h" 16 #include "llvm/ADT/ArrayRef.h" 17 #include "llvm/ADT/DenseMap.h" 18 #include "llvm/ADT/STLExtras.h" 19 #include "llvm/ADT/SmallVector.h" 20 #include "llvm/Analysis/InstructionSimplify.h" 21 #include "llvm/Analysis/VectorUtils.h" 22 #include "llvm/IR/BasicBlock.h" 23 #include "llvm/IR/Constant.h" 24 #include "llvm/IR/Constants.h" 25 #include "llvm/IR/DerivedTypes.h" 26 #include "llvm/IR/InstrTypes.h" 27 #include "llvm/IR/Instruction.h" 28 #include "llvm/IR/Instructions.h" 29 #include "llvm/IR/Operator.h" 30 #include "llvm/IR/PatternMatch.h" 31 #include "llvm/IR/Type.h" 32 #include "llvm/IR/User.h" 33 #include "llvm/IR/Value.h" 34 #include "llvm/Support/Casting.h" 35 #include "llvm/Support/ErrorHandling.h" 36 #include "llvm/Transforms/InstCombine/InstCombineWorklist.h" 37 #include <cassert> 38 #include <cstdint> 39 #include <iterator> 40 #include <utility> 41 42 using namespace llvm; 43 using namespace PatternMatch; 44 45 #define DEBUG_TYPE "instcombine" 46 47 /// Return true if the value is cheaper to scalarize than it is to leave as a 48 /// vector operation. IsConstantExtractIndex indicates whether we are extracting 49 /// one known element from a vector constant. 50 /// 51 /// FIXME: It's possible to create more instructions than previously existed. 52 static bool cheapToScalarize(Value *V, bool IsConstantExtractIndex) { 53 // If we can pick a scalar constant value out of a vector, that is free. 54 if (auto *C = dyn_cast<Constant>(V)) 55 return IsConstantExtractIndex || C->getSplatValue(); 56 57 // An insertelement to the same constant index as our extract will simplify 58 // to the scalar inserted element. An insertelement to a different constant 59 // index is irrelevant to our extract. 60 if (match(V, m_InsertElement(m_Value(), m_Value(), m_ConstantInt()))) 61 return IsConstantExtractIndex; 62 63 if (match(V, m_OneUse(m_Load(m_Value())))) 64 return true; 65 66 Value *V0, *V1; 67 if (match(V, m_OneUse(m_BinOp(m_Value(V0), m_Value(V1))))) 68 if (cheapToScalarize(V0, IsConstantExtractIndex) || 69 cheapToScalarize(V1, IsConstantExtractIndex)) 70 return true; 71 72 CmpInst::Predicate UnusedPred; 73 if (match(V, m_OneUse(m_Cmp(UnusedPred, m_Value(V0), m_Value(V1))))) 74 if (cheapToScalarize(V0, IsConstantExtractIndex) || 75 cheapToScalarize(V1, IsConstantExtractIndex)) 76 return true; 77 78 return false; 79 } 80 81 // If we have a PHI node with a vector type that is only used to feed 82 // itself and be an operand of extractelement at a constant location, 83 // try to replace the PHI of the vector type with a PHI of a scalar type. 84 Instruction *InstCombiner::scalarizePHI(ExtractElementInst &EI, PHINode *PN) { 85 SmallVector<Instruction *, 2> Extracts; 86 // The users we want the PHI to have are: 87 // 1) The EI ExtractElement (we already know this) 88 // 2) Possibly more ExtractElements with the same index. 89 // 3) Another operand, which will feed back into the PHI. 90 Instruction *PHIUser = nullptr; 91 for (auto U : PN->users()) { 92 if (ExtractElementInst *EU = dyn_cast<ExtractElementInst>(U)) { 93 if (EI.getIndexOperand() == EU->getIndexOperand()) 94 Extracts.push_back(EU); 95 else 96 return nullptr; 97 } else if (!PHIUser) { 98 PHIUser = cast<Instruction>(U); 99 } else { 100 return nullptr; 101 } 102 } 103 104 if (!PHIUser) 105 return nullptr; 106 107 // Verify that this PHI user has one use, which is the PHI itself, 108 // and that it is a binary operation which is cheap to scalarize. 109 // otherwise return nullptr. 110 if (!PHIUser->hasOneUse() || !(PHIUser->user_back() == PN) || 111 !(isa<BinaryOperator>(PHIUser)) || !cheapToScalarize(PHIUser, true)) 112 return nullptr; 113 114 // Create a scalar PHI node that will replace the vector PHI node 115 // just before the current PHI node. 116 PHINode *scalarPHI = cast<PHINode>(InsertNewInstWith( 117 PHINode::Create(EI.getType(), PN->getNumIncomingValues(), ""), *PN)); 118 // Scalarize each PHI operand. 119 for (unsigned i = 0; i < PN->getNumIncomingValues(); i++) { 120 Value *PHIInVal = PN->getIncomingValue(i); 121 BasicBlock *inBB = PN->getIncomingBlock(i); 122 Value *Elt = EI.getIndexOperand(); 123 // If the operand is the PHI induction variable: 124 if (PHIInVal == PHIUser) { 125 // Scalarize the binary operation. Its first operand is the 126 // scalar PHI, and the second operand is extracted from the other 127 // vector operand. 128 BinaryOperator *B0 = cast<BinaryOperator>(PHIUser); 129 unsigned opId = (B0->getOperand(0) == PN) ? 1 : 0; 130 Value *Op = InsertNewInstWith( 131 ExtractElementInst::Create(B0->getOperand(opId), Elt, 132 B0->getOperand(opId)->getName() + ".Elt"), 133 *B0); 134 Value *newPHIUser = InsertNewInstWith( 135 BinaryOperator::CreateWithCopiedFlags(B0->getOpcode(), 136 scalarPHI, Op, B0), *B0); 137 scalarPHI->addIncoming(newPHIUser, inBB); 138 } else { 139 // Scalarize PHI input: 140 Instruction *newEI = ExtractElementInst::Create(PHIInVal, Elt, ""); 141 // Insert the new instruction into the predecessor basic block. 142 Instruction *pos = dyn_cast<Instruction>(PHIInVal); 143 BasicBlock::iterator InsertPos; 144 if (pos && !isa<PHINode>(pos)) { 145 InsertPos = ++pos->getIterator(); 146 } else { 147 InsertPos = inBB->getFirstInsertionPt(); 148 } 149 150 InsertNewInstWith(newEI, *InsertPos); 151 152 scalarPHI->addIncoming(newEI, inBB); 153 } 154 } 155 156 for (auto E : Extracts) 157 replaceInstUsesWith(*E, scalarPHI); 158 159 return &EI; 160 } 161 162 static Instruction *foldBitcastExtElt(ExtractElementInst &Ext, 163 InstCombiner::BuilderTy &Builder, 164 bool IsBigEndian) { 165 Value *X; 166 uint64_t ExtIndexC; 167 if (!match(Ext.getVectorOperand(), m_BitCast(m_Value(X))) || 168 !X->getType()->isVectorTy() || 169 !match(Ext.getIndexOperand(), m_ConstantInt(ExtIndexC))) 170 return nullptr; 171 172 // If this extractelement is using a bitcast from a vector of the same number 173 // of elements, see if we can find the source element from the source vector: 174 // extelt (bitcast VecX), IndexC --> bitcast X[IndexC] 175 Type *SrcTy = X->getType(); 176 Type *DestTy = Ext.getType(); 177 unsigned NumSrcElts = SrcTy->getVectorNumElements(); 178 unsigned NumElts = Ext.getVectorOperandType()->getNumElements(); 179 if (NumSrcElts == NumElts) 180 if (Value *Elt = findScalarElement(X, ExtIndexC)) 181 return new BitCastInst(Elt, DestTy); 182 183 // If the source elements are wider than the destination, try to shift and 184 // truncate a subset of scalar bits of an insert op. 185 if (NumSrcElts < NumElts) { 186 Value *Scalar; 187 uint64_t InsIndexC; 188 if (!match(X, m_InsertElement(m_Value(), m_Value(Scalar), 189 m_ConstantInt(InsIndexC)))) 190 return nullptr; 191 192 // The extract must be from the subset of vector elements that we inserted 193 // into. Example: if we inserted element 1 of a <2 x i64> and we are 194 // extracting an i16 (narrowing ratio = 4), then this extract must be from 1 195 // of elements 4-7 of the bitcasted vector. 196 unsigned NarrowingRatio = NumElts / NumSrcElts; 197 if (ExtIndexC / NarrowingRatio != InsIndexC) 198 return nullptr; 199 200 // We are extracting part of the original scalar. How that scalar is 201 // inserted into the vector depends on the endian-ness. Example: 202 // Vector Byte Elt Index: 0 1 2 3 4 5 6 7 203 // +--+--+--+--+--+--+--+--+ 204 // inselt <2 x i32> V, <i32> S, 1: |V0|V1|V2|V3|S0|S1|S2|S3| 205 // extelt <4 x i16> V', 3: | |S2|S3| 206 // +--+--+--+--+--+--+--+--+ 207 // If this is little-endian, S2|S3 are the MSB of the 32-bit 'S' value. 208 // If this is big-endian, S2|S3 are the LSB of the 32-bit 'S' value. 209 // In this example, we must right-shift little-endian. Big-endian is just a 210 // truncate. 211 unsigned Chunk = ExtIndexC % NarrowingRatio; 212 if (IsBigEndian) 213 Chunk = NarrowingRatio - 1 - Chunk; 214 215 // Bail out if this is an FP vector to FP vector sequence. That would take 216 // more instructions than we started with unless there is no shift, and it 217 // may not be handled as well in the backend. 218 bool NeedSrcBitcast = SrcTy->getScalarType()->isFloatingPointTy(); 219 bool NeedDestBitcast = DestTy->isFloatingPointTy(); 220 if (NeedSrcBitcast && NeedDestBitcast) 221 return nullptr; 222 223 unsigned SrcWidth = SrcTy->getScalarSizeInBits(); 224 unsigned DestWidth = DestTy->getPrimitiveSizeInBits(); 225 unsigned ShAmt = Chunk * DestWidth; 226 227 // TODO: This limitation is more strict than necessary. We could sum the 228 // number of new instructions and subtract the number eliminated to know if 229 // we can proceed. 230 if (!X->hasOneUse() || !Ext.getVectorOperand()->hasOneUse()) 231 if (NeedSrcBitcast || NeedDestBitcast) 232 return nullptr; 233 234 if (NeedSrcBitcast) { 235 Type *SrcIntTy = IntegerType::getIntNTy(Scalar->getContext(), SrcWidth); 236 Scalar = Builder.CreateBitCast(Scalar, SrcIntTy); 237 } 238 239 if (ShAmt) { 240 // Bail out if we could end with more instructions than we started with. 241 if (!Ext.getVectorOperand()->hasOneUse()) 242 return nullptr; 243 Scalar = Builder.CreateLShr(Scalar, ShAmt); 244 } 245 246 if (NeedDestBitcast) { 247 Type *DestIntTy = IntegerType::getIntNTy(Scalar->getContext(), DestWidth); 248 return new BitCastInst(Builder.CreateTrunc(Scalar, DestIntTy), DestTy); 249 } 250 return new TruncInst(Scalar, DestTy); 251 } 252 253 return nullptr; 254 } 255 256 /// Find elements of V demanded by UserInstr. 257 static APInt findDemandedEltsBySingleUser(Value *V, Instruction *UserInstr) { 258 unsigned VWidth = V->getType()->getVectorNumElements(); 259 260 // Conservatively assume that all elements are needed. 261 APInt UsedElts(APInt::getAllOnesValue(VWidth)); 262 263 switch (UserInstr->getOpcode()) { 264 case Instruction::ExtractElement: { 265 ExtractElementInst *EEI = cast<ExtractElementInst>(UserInstr); 266 assert(EEI->getVectorOperand() == V); 267 ConstantInt *EEIIndexC = dyn_cast<ConstantInt>(EEI->getIndexOperand()); 268 if (EEIIndexC && EEIIndexC->getValue().ult(VWidth)) { 269 UsedElts = APInt::getOneBitSet(VWidth, EEIIndexC->getZExtValue()); 270 } 271 break; 272 } 273 case Instruction::ShuffleVector: { 274 ShuffleVectorInst *Shuffle = cast<ShuffleVectorInst>(UserInstr); 275 unsigned MaskNumElts = UserInstr->getType()->getVectorNumElements(); 276 277 UsedElts = APInt(VWidth, 0); 278 for (unsigned i = 0; i < MaskNumElts; i++) { 279 unsigned MaskVal = Shuffle->getMaskValue(i); 280 if (MaskVal == -1u || MaskVal >= 2 * VWidth) 281 continue; 282 if (Shuffle->getOperand(0) == V && (MaskVal < VWidth)) 283 UsedElts.setBit(MaskVal); 284 if (Shuffle->getOperand(1) == V && 285 ((MaskVal >= VWidth) && (MaskVal < 2 * VWidth))) 286 UsedElts.setBit(MaskVal - VWidth); 287 } 288 break; 289 } 290 default: 291 break; 292 } 293 return UsedElts; 294 } 295 296 /// Find union of elements of V demanded by all its users. 297 /// If it is known by querying findDemandedEltsBySingleUser that 298 /// no user demands an element of V, then the corresponding bit 299 /// remains unset in the returned value. 300 static APInt findDemandedEltsByAllUsers(Value *V) { 301 unsigned VWidth = V->getType()->getVectorNumElements(); 302 303 APInt UnionUsedElts(VWidth, 0); 304 for (const Use &U : V->uses()) { 305 if (Instruction *I = dyn_cast<Instruction>(U.getUser())) { 306 UnionUsedElts |= findDemandedEltsBySingleUser(V, I); 307 } else { 308 UnionUsedElts = APInt::getAllOnesValue(VWidth); 309 break; 310 } 311 312 if (UnionUsedElts.isAllOnesValue()) 313 break; 314 } 315 316 return UnionUsedElts; 317 } 318 319 Instruction *InstCombiner::visitExtractElementInst(ExtractElementInst &EI) { 320 Value *SrcVec = EI.getVectorOperand(); 321 Value *Index = EI.getIndexOperand(); 322 if (Value *V = SimplifyExtractElementInst(SrcVec, Index, 323 SQ.getWithInstruction(&EI))) 324 return replaceInstUsesWith(EI, V); 325 326 // If extracting a specified index from the vector, see if we can recursively 327 // find a previously computed scalar that was inserted into the vector. 328 auto *IndexC = dyn_cast<ConstantInt>(Index); 329 if (IndexC) { 330 unsigned NumElts = EI.getVectorOperandType()->getNumElements(); 331 332 // InstSimplify should handle cases where the index is invalid. 333 if (!IndexC->getValue().ule(NumElts)) 334 return nullptr; 335 336 // This instruction only demands the single element from the input vector. 337 if (NumElts != 1) { 338 // If the input vector has a single use, simplify it based on this use 339 // property. 340 if (SrcVec->hasOneUse()) { 341 APInt UndefElts(NumElts, 0); 342 APInt DemandedElts(NumElts, 0); 343 DemandedElts.setBit(IndexC->getZExtValue()); 344 if (Value *V = 345 SimplifyDemandedVectorElts(SrcVec, DemandedElts, UndefElts)) { 346 EI.setOperand(0, V); 347 return &EI; 348 } 349 } else { 350 // If the input vector has multiple uses, simplify it based on a union 351 // of all elements used. 352 APInt DemandedElts = findDemandedEltsByAllUsers(SrcVec); 353 if (!DemandedElts.isAllOnesValue()) { 354 APInt UndefElts(NumElts, 0); 355 if (Value *V = SimplifyDemandedVectorElts( 356 SrcVec, DemandedElts, UndefElts, 0 /* Depth */, 357 true /* AllowMultipleUsers */)) { 358 if (V != SrcVec) { 359 SrcVec->replaceAllUsesWith(V); 360 return &EI; 361 } 362 } 363 } 364 } 365 } 366 if (Instruction *I = foldBitcastExtElt(EI, Builder, DL.isBigEndian())) 367 return I; 368 369 // If there's a vector PHI feeding a scalar use through this extractelement 370 // instruction, try to scalarize the PHI. 371 if (auto *Phi = dyn_cast<PHINode>(SrcVec)) 372 if (Instruction *ScalarPHI = scalarizePHI(EI, Phi)) 373 return ScalarPHI; 374 } 375 376 BinaryOperator *BO; 377 if (match(SrcVec, m_BinOp(BO)) && cheapToScalarize(SrcVec, IndexC)) { 378 // extelt (binop X, Y), Index --> binop (extelt X, Index), (extelt Y, Index) 379 Value *X = BO->getOperand(0), *Y = BO->getOperand(1); 380 Value *E0 = Builder.CreateExtractElement(X, Index); 381 Value *E1 = Builder.CreateExtractElement(Y, Index); 382 return BinaryOperator::CreateWithCopiedFlags(BO->getOpcode(), E0, E1, BO); 383 } 384 385 Value *X, *Y; 386 CmpInst::Predicate Pred; 387 if (match(SrcVec, m_Cmp(Pred, m_Value(X), m_Value(Y))) && 388 cheapToScalarize(SrcVec, IndexC)) { 389 // extelt (cmp X, Y), Index --> cmp (extelt X, Index), (extelt Y, Index) 390 Value *E0 = Builder.CreateExtractElement(X, Index); 391 Value *E1 = Builder.CreateExtractElement(Y, Index); 392 return CmpInst::Create(cast<CmpInst>(SrcVec)->getOpcode(), Pred, E0, E1); 393 } 394 395 if (auto *I = dyn_cast<Instruction>(SrcVec)) { 396 if (auto *IE = dyn_cast<InsertElementInst>(I)) { 397 // Extracting the inserted element? 398 if (IE->getOperand(2) == Index) 399 return replaceInstUsesWith(EI, IE->getOperand(1)); 400 // If the inserted and extracted elements are constants, they must not 401 // be the same value, extract from the pre-inserted value instead. 402 if (isa<Constant>(IE->getOperand(2)) && IndexC) { 403 Worklist.AddValue(SrcVec); 404 EI.setOperand(0, IE->getOperand(0)); 405 return &EI; 406 } 407 } else if (auto *SVI = dyn_cast<ShuffleVectorInst>(I)) { 408 // If this is extracting an element from a shufflevector, figure out where 409 // it came from and extract from the appropriate input element instead. 410 if (auto *Elt = dyn_cast<ConstantInt>(Index)) { 411 int SrcIdx = SVI->getMaskValue(Elt->getZExtValue()); 412 Value *Src; 413 unsigned LHSWidth = 414 SVI->getOperand(0)->getType()->getVectorNumElements(); 415 416 if (SrcIdx < 0) 417 return replaceInstUsesWith(EI, UndefValue::get(EI.getType())); 418 if (SrcIdx < (int)LHSWidth) 419 Src = SVI->getOperand(0); 420 else { 421 SrcIdx -= LHSWidth; 422 Src = SVI->getOperand(1); 423 } 424 Type *Int32Ty = Type::getInt32Ty(EI.getContext()); 425 return ExtractElementInst::Create(Src, 426 ConstantInt::get(Int32Ty, 427 SrcIdx, false)); 428 } 429 } else if (auto *CI = dyn_cast<CastInst>(I)) { 430 // Canonicalize extractelement(cast) -> cast(extractelement). 431 // Bitcasts can change the number of vector elements, and they cost 432 // nothing. 433 if (CI->hasOneUse() && (CI->getOpcode() != Instruction::BitCast)) { 434 Value *EE = Builder.CreateExtractElement(CI->getOperand(0), Index); 435 return CastInst::Create(CI->getOpcode(), EE, EI.getType()); 436 } 437 } 438 } 439 return nullptr; 440 } 441 442 /// If V is a shuffle of values that ONLY returns elements from either LHS or 443 /// RHS, return the shuffle mask and true. Otherwise, return false. 444 static bool collectSingleShuffleElements(Value *V, Value *LHS, Value *RHS, 445 SmallVectorImpl<Constant*> &Mask) { 446 assert(LHS->getType() == RHS->getType() && 447 "Invalid CollectSingleShuffleElements"); 448 unsigned NumElts = V->getType()->getVectorNumElements(); 449 450 if (isa<UndefValue>(V)) { 451 Mask.assign(NumElts, UndefValue::get(Type::getInt32Ty(V->getContext()))); 452 return true; 453 } 454 455 if (V == LHS) { 456 for (unsigned i = 0; i != NumElts; ++i) 457 Mask.push_back(ConstantInt::get(Type::getInt32Ty(V->getContext()), i)); 458 return true; 459 } 460 461 if (V == RHS) { 462 for (unsigned i = 0; i != NumElts; ++i) 463 Mask.push_back(ConstantInt::get(Type::getInt32Ty(V->getContext()), 464 i+NumElts)); 465 return true; 466 } 467 468 if (InsertElementInst *IEI = dyn_cast<InsertElementInst>(V)) { 469 // If this is an insert of an extract from some other vector, include it. 470 Value *VecOp = IEI->getOperand(0); 471 Value *ScalarOp = IEI->getOperand(1); 472 Value *IdxOp = IEI->getOperand(2); 473 474 if (!isa<ConstantInt>(IdxOp)) 475 return false; 476 unsigned InsertedIdx = cast<ConstantInt>(IdxOp)->getZExtValue(); 477 478 if (isa<UndefValue>(ScalarOp)) { // inserting undef into vector. 479 // We can handle this if the vector we are inserting into is 480 // transitively ok. 481 if (collectSingleShuffleElements(VecOp, LHS, RHS, Mask)) { 482 // If so, update the mask to reflect the inserted undef. 483 Mask[InsertedIdx] = UndefValue::get(Type::getInt32Ty(V->getContext())); 484 return true; 485 } 486 } else if (ExtractElementInst *EI = dyn_cast<ExtractElementInst>(ScalarOp)){ 487 if (isa<ConstantInt>(EI->getOperand(1))) { 488 unsigned ExtractedIdx = 489 cast<ConstantInt>(EI->getOperand(1))->getZExtValue(); 490 unsigned NumLHSElts = LHS->getType()->getVectorNumElements(); 491 492 // This must be extracting from either LHS or RHS. 493 if (EI->getOperand(0) == LHS || EI->getOperand(0) == RHS) { 494 // We can handle this if the vector we are inserting into is 495 // transitively ok. 496 if (collectSingleShuffleElements(VecOp, LHS, RHS, Mask)) { 497 // If so, update the mask to reflect the inserted value. 498 if (EI->getOperand(0) == LHS) { 499 Mask[InsertedIdx % NumElts] = 500 ConstantInt::get(Type::getInt32Ty(V->getContext()), 501 ExtractedIdx); 502 } else { 503 assert(EI->getOperand(0) == RHS); 504 Mask[InsertedIdx % NumElts] = 505 ConstantInt::get(Type::getInt32Ty(V->getContext()), 506 ExtractedIdx + NumLHSElts); 507 } 508 return true; 509 } 510 } 511 } 512 } 513 } 514 515 return false; 516 } 517 518 /// If we have insertion into a vector that is wider than the vector that we 519 /// are extracting from, try to widen the source vector to allow a single 520 /// shufflevector to replace one or more insert/extract pairs. 521 static void replaceExtractElements(InsertElementInst *InsElt, 522 ExtractElementInst *ExtElt, 523 InstCombiner &IC) { 524 VectorType *InsVecType = InsElt->getType(); 525 VectorType *ExtVecType = ExtElt->getVectorOperandType(); 526 unsigned NumInsElts = InsVecType->getVectorNumElements(); 527 unsigned NumExtElts = ExtVecType->getVectorNumElements(); 528 529 // The inserted-to vector must be wider than the extracted-from vector. 530 if (InsVecType->getElementType() != ExtVecType->getElementType() || 531 NumExtElts >= NumInsElts) 532 return; 533 534 // Create a shuffle mask to widen the extended-from vector using undefined 535 // values. The mask selects all of the values of the original vector followed 536 // by as many undefined values as needed to create a vector of the same length 537 // as the inserted-to vector. 538 SmallVector<Constant *, 16> ExtendMask; 539 IntegerType *IntType = Type::getInt32Ty(InsElt->getContext()); 540 for (unsigned i = 0; i < NumExtElts; ++i) 541 ExtendMask.push_back(ConstantInt::get(IntType, i)); 542 for (unsigned i = NumExtElts; i < NumInsElts; ++i) 543 ExtendMask.push_back(UndefValue::get(IntType)); 544 545 Value *ExtVecOp = ExtElt->getVectorOperand(); 546 auto *ExtVecOpInst = dyn_cast<Instruction>(ExtVecOp); 547 BasicBlock *InsertionBlock = (ExtVecOpInst && !isa<PHINode>(ExtVecOpInst)) 548 ? ExtVecOpInst->getParent() 549 : ExtElt->getParent(); 550 551 // TODO: This restriction matches the basic block check below when creating 552 // new extractelement instructions. If that limitation is removed, this one 553 // could also be removed. But for now, we just bail out to ensure that we 554 // will replace the extractelement instruction that is feeding our 555 // insertelement instruction. This allows the insertelement to then be 556 // replaced by a shufflevector. If the insertelement is not replaced, we can 557 // induce infinite looping because there's an optimization for extractelement 558 // that will delete our widening shuffle. This would trigger another attempt 559 // here to create that shuffle, and we spin forever. 560 if (InsertionBlock != InsElt->getParent()) 561 return; 562 563 // TODO: This restriction matches the check in visitInsertElementInst() and 564 // prevents an infinite loop caused by not turning the extract/insert pair 565 // into a shuffle. We really should not need either check, but we're lacking 566 // folds for shufflevectors because we're afraid to generate shuffle masks 567 // that the backend can't handle. 568 if (InsElt->hasOneUse() && isa<InsertElementInst>(InsElt->user_back())) 569 return; 570 571 auto *WideVec = new ShuffleVectorInst(ExtVecOp, UndefValue::get(ExtVecType), 572 ConstantVector::get(ExtendMask)); 573 574 // Insert the new shuffle after the vector operand of the extract is defined 575 // (as long as it's not a PHI) or at the start of the basic block of the 576 // extract, so any subsequent extracts in the same basic block can use it. 577 // TODO: Insert before the earliest ExtractElementInst that is replaced. 578 if (ExtVecOpInst && !isa<PHINode>(ExtVecOpInst)) 579 WideVec->insertAfter(ExtVecOpInst); 580 else 581 IC.InsertNewInstWith(WideVec, *ExtElt->getParent()->getFirstInsertionPt()); 582 583 // Replace extracts from the original narrow vector with extracts from the new 584 // wide vector. 585 for (User *U : ExtVecOp->users()) { 586 ExtractElementInst *OldExt = dyn_cast<ExtractElementInst>(U); 587 if (!OldExt || OldExt->getParent() != WideVec->getParent()) 588 continue; 589 auto *NewExt = ExtractElementInst::Create(WideVec, OldExt->getOperand(1)); 590 NewExt->insertAfter(OldExt); 591 IC.replaceInstUsesWith(*OldExt, NewExt); 592 } 593 } 594 595 /// We are building a shuffle to create V, which is a sequence of insertelement, 596 /// extractelement pairs. If PermittedRHS is set, then we must either use it or 597 /// not rely on the second vector source. Return a std::pair containing the 598 /// left and right vectors of the proposed shuffle (or 0), and set the Mask 599 /// parameter as required. 600 /// 601 /// Note: we intentionally don't try to fold earlier shuffles since they have 602 /// often been chosen carefully to be efficiently implementable on the target. 603 using ShuffleOps = std::pair<Value *, Value *>; 604 605 static ShuffleOps collectShuffleElements(Value *V, 606 SmallVectorImpl<Constant *> &Mask, 607 Value *PermittedRHS, 608 InstCombiner &IC) { 609 assert(V->getType()->isVectorTy() && "Invalid shuffle!"); 610 unsigned NumElts = V->getType()->getVectorNumElements(); 611 612 if (isa<UndefValue>(V)) { 613 Mask.assign(NumElts, UndefValue::get(Type::getInt32Ty(V->getContext()))); 614 return std::make_pair( 615 PermittedRHS ? UndefValue::get(PermittedRHS->getType()) : V, nullptr); 616 } 617 618 if (isa<ConstantAggregateZero>(V)) { 619 Mask.assign(NumElts, ConstantInt::get(Type::getInt32Ty(V->getContext()),0)); 620 return std::make_pair(V, nullptr); 621 } 622 623 if (InsertElementInst *IEI = dyn_cast<InsertElementInst>(V)) { 624 // If this is an insert of an extract from some other vector, include it. 625 Value *VecOp = IEI->getOperand(0); 626 Value *ScalarOp = IEI->getOperand(1); 627 Value *IdxOp = IEI->getOperand(2); 628 629 if (ExtractElementInst *EI = dyn_cast<ExtractElementInst>(ScalarOp)) { 630 if (isa<ConstantInt>(EI->getOperand(1)) && isa<ConstantInt>(IdxOp)) { 631 unsigned ExtractedIdx = 632 cast<ConstantInt>(EI->getOperand(1))->getZExtValue(); 633 unsigned InsertedIdx = cast<ConstantInt>(IdxOp)->getZExtValue(); 634 635 // Either the extracted from or inserted into vector must be RHSVec, 636 // otherwise we'd end up with a shuffle of three inputs. 637 if (EI->getOperand(0) == PermittedRHS || PermittedRHS == nullptr) { 638 Value *RHS = EI->getOperand(0); 639 ShuffleOps LR = collectShuffleElements(VecOp, Mask, RHS, IC); 640 assert(LR.second == nullptr || LR.second == RHS); 641 642 if (LR.first->getType() != RHS->getType()) { 643 // Although we are giving up for now, see if we can create extracts 644 // that match the inserts for another round of combining. 645 replaceExtractElements(IEI, EI, IC); 646 647 // We tried our best, but we can't find anything compatible with RHS 648 // further up the chain. Return a trivial shuffle. 649 for (unsigned i = 0; i < NumElts; ++i) 650 Mask[i] = ConstantInt::get(Type::getInt32Ty(V->getContext()), i); 651 return std::make_pair(V, nullptr); 652 } 653 654 unsigned NumLHSElts = RHS->getType()->getVectorNumElements(); 655 Mask[InsertedIdx % NumElts] = 656 ConstantInt::get(Type::getInt32Ty(V->getContext()), 657 NumLHSElts+ExtractedIdx); 658 return std::make_pair(LR.first, RHS); 659 } 660 661 if (VecOp == PermittedRHS) { 662 // We've gone as far as we can: anything on the other side of the 663 // extractelement will already have been converted into a shuffle. 664 unsigned NumLHSElts = 665 EI->getOperand(0)->getType()->getVectorNumElements(); 666 for (unsigned i = 0; i != NumElts; ++i) 667 Mask.push_back(ConstantInt::get( 668 Type::getInt32Ty(V->getContext()), 669 i == InsertedIdx ? ExtractedIdx : NumLHSElts + i)); 670 return std::make_pair(EI->getOperand(0), PermittedRHS); 671 } 672 673 // If this insertelement is a chain that comes from exactly these two 674 // vectors, return the vector and the effective shuffle. 675 if (EI->getOperand(0)->getType() == PermittedRHS->getType() && 676 collectSingleShuffleElements(IEI, EI->getOperand(0), PermittedRHS, 677 Mask)) 678 return std::make_pair(EI->getOperand(0), PermittedRHS); 679 } 680 } 681 } 682 683 // Otherwise, we can't do anything fancy. Return an identity vector. 684 for (unsigned i = 0; i != NumElts; ++i) 685 Mask.push_back(ConstantInt::get(Type::getInt32Ty(V->getContext()), i)); 686 return std::make_pair(V, nullptr); 687 } 688 689 /// Try to find redundant insertvalue instructions, like the following ones: 690 /// %0 = insertvalue { i8, i32 } undef, i8 %x, 0 691 /// %1 = insertvalue { i8, i32 } %0, i8 %y, 0 692 /// Here the second instruction inserts values at the same indices, as the 693 /// first one, making the first one redundant. 694 /// It should be transformed to: 695 /// %0 = insertvalue { i8, i32 } undef, i8 %y, 0 696 Instruction *InstCombiner::visitInsertValueInst(InsertValueInst &I) { 697 bool IsRedundant = false; 698 ArrayRef<unsigned int> FirstIndices = I.getIndices(); 699 700 // If there is a chain of insertvalue instructions (each of them except the 701 // last one has only one use and it's another insertvalue insn from this 702 // chain), check if any of the 'children' uses the same indices as the first 703 // instruction. In this case, the first one is redundant. 704 Value *V = &I; 705 unsigned Depth = 0; 706 while (V->hasOneUse() && Depth < 10) { 707 User *U = V->user_back(); 708 auto UserInsInst = dyn_cast<InsertValueInst>(U); 709 if (!UserInsInst || U->getOperand(0) != V) 710 break; 711 if (UserInsInst->getIndices() == FirstIndices) { 712 IsRedundant = true; 713 break; 714 } 715 V = UserInsInst; 716 Depth++; 717 } 718 719 if (IsRedundant) 720 return replaceInstUsesWith(I, I.getOperand(0)); 721 return nullptr; 722 } 723 724 static bool isShuffleEquivalentToSelect(ShuffleVectorInst &Shuf) { 725 int MaskSize = Shuf.getMask()->getType()->getVectorNumElements(); 726 int VecSize = Shuf.getOperand(0)->getType()->getVectorNumElements(); 727 728 // A vector select does not change the size of the operands. 729 if (MaskSize != VecSize) 730 return false; 731 732 // Each mask element must be undefined or choose a vector element from one of 733 // the source operands without crossing vector lanes. 734 for (int i = 0; i != MaskSize; ++i) { 735 int Elt = Shuf.getMaskValue(i); 736 if (Elt != -1 && Elt != i && Elt != i + VecSize) 737 return false; 738 } 739 740 return true; 741 } 742 743 /// Turn a chain of inserts that splats a value into an insert + shuffle: 744 /// insertelt(insertelt(insertelt(insertelt X, %k, 0), %k, 1), %k, 2) ... -> 745 /// shufflevector(insertelt(X, %k, 0), undef, zero) 746 static Instruction *foldInsSequenceIntoSplat(InsertElementInst &InsElt) { 747 // We are interested in the last insert in a chain. So if this insert has a 748 // single user and that user is an insert, bail. 749 if (InsElt.hasOneUse() && isa<InsertElementInst>(InsElt.user_back())) 750 return nullptr; 751 752 auto *VecTy = cast<VectorType>(InsElt.getType()); 753 unsigned NumElements = VecTy->getNumElements(); 754 755 // Do not try to do this for a one-element vector, since that's a nop, 756 // and will cause an inf-loop. 757 if (NumElements == 1) 758 return nullptr; 759 760 Value *SplatVal = InsElt.getOperand(1); 761 InsertElementInst *CurrIE = &InsElt; 762 SmallVector<bool, 16> ElementPresent(NumElements, false); 763 InsertElementInst *FirstIE = nullptr; 764 765 // Walk the chain backwards, keeping track of which indices we inserted into, 766 // until we hit something that isn't an insert of the splatted value. 767 while (CurrIE) { 768 auto *Idx = dyn_cast<ConstantInt>(CurrIE->getOperand(2)); 769 if (!Idx || CurrIE->getOperand(1) != SplatVal) 770 return nullptr; 771 772 auto *NextIE = dyn_cast<InsertElementInst>(CurrIE->getOperand(0)); 773 // Check none of the intermediate steps have any additional uses, except 774 // for the root insertelement instruction, which can be re-used, if it 775 // inserts at position 0. 776 if (CurrIE != &InsElt && 777 (!CurrIE->hasOneUse() && (NextIE != nullptr || !Idx->isZero()))) 778 return nullptr; 779 780 ElementPresent[Idx->getZExtValue()] = true; 781 FirstIE = CurrIE; 782 CurrIE = NextIE; 783 } 784 785 // If this is just a single insertelement (not a sequence), we are done. 786 if (FirstIE == &InsElt) 787 return nullptr; 788 789 // If we are not inserting into an undef vector, make sure we've seen an 790 // insert into every element. 791 // TODO: If the base vector is not undef, it might be better to create a splat 792 // and then a select-shuffle (blend) with the base vector. 793 if (!isa<UndefValue>(FirstIE->getOperand(0))) 794 if (any_of(ElementPresent, [](bool Present) { return !Present; })) 795 return nullptr; 796 797 // Create the insert + shuffle. 798 Type *Int32Ty = Type::getInt32Ty(InsElt.getContext()); 799 UndefValue *UndefVec = UndefValue::get(VecTy); 800 Constant *Zero = ConstantInt::get(Int32Ty, 0); 801 if (!cast<ConstantInt>(FirstIE->getOperand(2))->isZero()) 802 FirstIE = InsertElementInst::Create(UndefVec, SplatVal, Zero, "", &InsElt); 803 804 // Splat from element 0, but replace absent elements with undef in the mask. 805 SmallVector<Constant *, 16> Mask(NumElements, Zero); 806 for (unsigned i = 0; i != NumElements; ++i) 807 if (!ElementPresent[i]) 808 Mask[i] = UndefValue::get(Int32Ty); 809 810 return new ShuffleVectorInst(FirstIE, UndefVec, ConstantVector::get(Mask)); 811 } 812 813 /// Try to fold an insert element into an existing splat shuffle by changing 814 /// the shuffle's mask to include the index of this insert element. 815 static Instruction *foldInsEltIntoSplat(InsertElementInst &InsElt) { 816 // Check if the vector operand of this insert is a canonical splat shuffle. 817 auto *Shuf = dyn_cast<ShuffleVectorInst>(InsElt.getOperand(0)); 818 if (!Shuf || !Shuf->isZeroEltSplat()) 819 return nullptr; 820 821 // Check for a constant insertion index. 822 uint64_t IdxC; 823 if (!match(InsElt.getOperand(2), m_ConstantInt(IdxC))) 824 return nullptr; 825 826 // Check if the splat shuffle's input is the same as this insert's scalar op. 827 Value *X = InsElt.getOperand(1); 828 Value *Op0 = Shuf->getOperand(0); 829 if (!match(Op0, m_InsertElement(m_Undef(), m_Specific(X), m_ZeroInt()))) 830 return nullptr; 831 832 // Replace the shuffle mask element at the index of this insert with a zero. 833 // For example: 834 // inselt (shuf (inselt undef, X, 0), undef, <0,undef,0,undef>), X, 1 835 // --> shuf (inselt undef, X, 0), undef, <0,0,0,undef> 836 unsigned NumMaskElts = Shuf->getType()->getVectorNumElements(); 837 SmallVector<Constant *, 16> NewMaskVec(NumMaskElts); 838 Type *I32Ty = IntegerType::getInt32Ty(Shuf->getContext()); 839 Constant *Zero = ConstantInt::getNullValue(I32Ty); 840 for (unsigned i = 0; i != NumMaskElts; ++i) 841 NewMaskVec[i] = i == IdxC ? Zero : Shuf->getMask()->getAggregateElement(i); 842 843 Constant *NewMask = ConstantVector::get(NewMaskVec); 844 return new ShuffleVectorInst(Op0, UndefValue::get(Op0->getType()), NewMask); 845 } 846 847 /// Try to fold an extract+insert element into an existing identity shuffle by 848 /// changing the shuffle's mask to include the index of this insert element. 849 static Instruction *foldInsEltIntoIdentityShuffle(InsertElementInst &InsElt) { 850 // Check if the vector operand of this insert is an identity shuffle. 851 auto *Shuf = dyn_cast<ShuffleVectorInst>(InsElt.getOperand(0)); 852 if (!Shuf || !isa<UndefValue>(Shuf->getOperand(1)) || 853 !(Shuf->isIdentityWithExtract() || Shuf->isIdentityWithPadding())) 854 return nullptr; 855 856 // Check for a constant insertion index. 857 uint64_t IdxC; 858 if (!match(InsElt.getOperand(2), m_ConstantInt(IdxC))) 859 return nullptr; 860 861 // Check if this insert's scalar op is extracted from the identity shuffle's 862 // input vector. 863 Value *Scalar = InsElt.getOperand(1); 864 Value *X = Shuf->getOperand(0); 865 if (!match(Scalar, m_ExtractElement(m_Specific(X), m_SpecificInt(IdxC)))) 866 return nullptr; 867 868 // Replace the shuffle mask element at the index of this extract+insert with 869 // that same index value. 870 // For example: 871 // inselt (shuf X, IdMask), (extelt X, IdxC), IdxC --> shuf X, IdMask' 872 unsigned NumMaskElts = Shuf->getType()->getVectorNumElements(); 873 SmallVector<Constant *, 16> NewMaskVec(NumMaskElts); 874 Type *I32Ty = IntegerType::getInt32Ty(Shuf->getContext()); 875 Constant *NewMaskEltC = ConstantInt::get(I32Ty, IdxC); 876 Constant *OldMask = Shuf->getMask(); 877 for (unsigned i = 0; i != NumMaskElts; ++i) { 878 if (i != IdxC) { 879 // All mask elements besides the inserted element remain the same. 880 NewMaskVec[i] = OldMask->getAggregateElement(i); 881 } else if (OldMask->getAggregateElement(i) == NewMaskEltC) { 882 // If the mask element was already set, there's nothing to do 883 // (demanded elements analysis may unset it later). 884 return nullptr; 885 } else { 886 assert(isa<UndefValue>(OldMask->getAggregateElement(i)) && 887 "Unexpected shuffle mask element for identity shuffle"); 888 NewMaskVec[i] = NewMaskEltC; 889 } 890 } 891 892 Constant *NewMask = ConstantVector::get(NewMaskVec); 893 return new ShuffleVectorInst(X, Shuf->getOperand(1), NewMask); 894 } 895 896 /// If we have an insertelement instruction feeding into another insertelement 897 /// and the 2nd is inserting a constant into the vector, canonicalize that 898 /// constant insertion before the insertion of a variable: 899 /// 900 /// insertelement (insertelement X, Y, IdxC1), ScalarC, IdxC2 --> 901 /// insertelement (insertelement X, ScalarC, IdxC2), Y, IdxC1 902 /// 903 /// This has the potential of eliminating the 2nd insertelement instruction 904 /// via constant folding of the scalar constant into a vector constant. 905 static Instruction *hoistInsEltConst(InsertElementInst &InsElt2, 906 InstCombiner::BuilderTy &Builder) { 907 auto *InsElt1 = dyn_cast<InsertElementInst>(InsElt2.getOperand(0)); 908 if (!InsElt1 || !InsElt1->hasOneUse()) 909 return nullptr; 910 911 Value *X, *Y; 912 Constant *ScalarC; 913 ConstantInt *IdxC1, *IdxC2; 914 if (match(InsElt1->getOperand(0), m_Value(X)) && 915 match(InsElt1->getOperand(1), m_Value(Y)) && !isa<Constant>(Y) && 916 match(InsElt1->getOperand(2), m_ConstantInt(IdxC1)) && 917 match(InsElt2.getOperand(1), m_Constant(ScalarC)) && 918 match(InsElt2.getOperand(2), m_ConstantInt(IdxC2)) && IdxC1 != IdxC2) { 919 Value *NewInsElt1 = Builder.CreateInsertElement(X, ScalarC, IdxC2); 920 return InsertElementInst::Create(NewInsElt1, Y, IdxC1); 921 } 922 923 return nullptr; 924 } 925 926 /// insertelt (shufflevector X, CVec, Mask|insertelt X, C1, CIndex1), C, CIndex 927 /// --> shufflevector X, CVec', Mask' 928 static Instruction *foldConstantInsEltIntoShuffle(InsertElementInst &InsElt) { 929 auto *Inst = dyn_cast<Instruction>(InsElt.getOperand(0)); 930 // Bail out if the parent has more than one use. In that case, we'd be 931 // replacing the insertelt with a shuffle, and that's not a clear win. 932 if (!Inst || !Inst->hasOneUse()) 933 return nullptr; 934 if (auto *Shuf = dyn_cast<ShuffleVectorInst>(InsElt.getOperand(0))) { 935 // The shuffle must have a constant vector operand. The insertelt must have 936 // a constant scalar being inserted at a constant position in the vector. 937 Constant *ShufConstVec, *InsEltScalar; 938 uint64_t InsEltIndex; 939 if (!match(Shuf->getOperand(1), m_Constant(ShufConstVec)) || 940 !match(InsElt.getOperand(1), m_Constant(InsEltScalar)) || 941 !match(InsElt.getOperand(2), m_ConstantInt(InsEltIndex))) 942 return nullptr; 943 944 // Adding an element to an arbitrary shuffle could be expensive, but a 945 // shuffle that selects elements from vectors without crossing lanes is 946 // assumed cheap. 947 // If we're just adding a constant into that shuffle, it will still be 948 // cheap. 949 if (!isShuffleEquivalentToSelect(*Shuf)) 950 return nullptr; 951 952 // From the above 'select' check, we know that the mask has the same number 953 // of elements as the vector input operands. We also know that each constant 954 // input element is used in its lane and can not be used more than once by 955 // the shuffle. Therefore, replace the constant in the shuffle's constant 956 // vector with the insertelt constant. Replace the constant in the shuffle's 957 // mask vector with the insertelt index plus the length of the vector 958 // (because the constant vector operand of a shuffle is always the 2nd 959 // operand). 960 Constant *Mask = Shuf->getMask(); 961 unsigned NumElts = Mask->getType()->getVectorNumElements(); 962 SmallVector<Constant *, 16> NewShufElts(NumElts); 963 SmallVector<Constant *, 16> NewMaskElts(NumElts); 964 for (unsigned I = 0; I != NumElts; ++I) { 965 if (I == InsEltIndex) { 966 NewShufElts[I] = InsEltScalar; 967 Type *Int32Ty = Type::getInt32Ty(Shuf->getContext()); 968 NewMaskElts[I] = ConstantInt::get(Int32Ty, InsEltIndex + NumElts); 969 } else { 970 // Copy over the existing values. 971 NewShufElts[I] = ShufConstVec->getAggregateElement(I); 972 NewMaskElts[I] = Mask->getAggregateElement(I); 973 } 974 } 975 976 // Create new operands for a shuffle that includes the constant of the 977 // original insertelt. The old shuffle will be dead now. 978 return new ShuffleVectorInst(Shuf->getOperand(0), 979 ConstantVector::get(NewShufElts), 980 ConstantVector::get(NewMaskElts)); 981 } else if (auto *IEI = dyn_cast<InsertElementInst>(Inst)) { 982 // Transform sequences of insertelements ops with constant data/indexes into 983 // a single shuffle op. 984 unsigned NumElts = InsElt.getType()->getNumElements(); 985 986 uint64_t InsertIdx[2]; 987 Constant *Val[2]; 988 if (!match(InsElt.getOperand(2), m_ConstantInt(InsertIdx[0])) || 989 !match(InsElt.getOperand(1), m_Constant(Val[0])) || 990 !match(IEI->getOperand(2), m_ConstantInt(InsertIdx[1])) || 991 !match(IEI->getOperand(1), m_Constant(Val[1]))) 992 return nullptr; 993 SmallVector<Constant *, 16> Values(NumElts); 994 SmallVector<Constant *, 16> Mask(NumElts); 995 auto ValI = std::begin(Val); 996 // Generate new constant vector and mask. 997 // We have 2 values/masks from the insertelements instructions. Insert them 998 // into new value/mask vectors. 999 for (uint64_t I : InsertIdx) { 1000 if (!Values[I]) { 1001 assert(!Mask[I]); 1002 Values[I] = *ValI; 1003 Mask[I] = ConstantInt::get(Type::getInt32Ty(InsElt.getContext()), 1004 NumElts + I); 1005 } 1006 ++ValI; 1007 } 1008 // Remaining values are filled with 'undef' values. 1009 for (unsigned I = 0; I < NumElts; ++I) { 1010 if (!Values[I]) { 1011 assert(!Mask[I]); 1012 Values[I] = UndefValue::get(InsElt.getType()->getElementType()); 1013 Mask[I] = ConstantInt::get(Type::getInt32Ty(InsElt.getContext()), I); 1014 } 1015 } 1016 // Create new operands for a shuffle that includes the constant of the 1017 // original insertelt. 1018 return new ShuffleVectorInst(IEI->getOperand(0), 1019 ConstantVector::get(Values), 1020 ConstantVector::get(Mask)); 1021 } 1022 return nullptr; 1023 } 1024 1025 Instruction *InstCombiner::visitInsertElementInst(InsertElementInst &IE) { 1026 Value *VecOp = IE.getOperand(0); 1027 Value *ScalarOp = IE.getOperand(1); 1028 Value *IdxOp = IE.getOperand(2); 1029 1030 if (auto *V = SimplifyInsertElementInst( 1031 VecOp, ScalarOp, IdxOp, SQ.getWithInstruction(&IE))) 1032 return replaceInstUsesWith(IE, V); 1033 1034 // If the vector and scalar are both bitcast from the same element type, do 1035 // the insert in that source type followed by bitcast. 1036 Value *VecSrc, *ScalarSrc; 1037 if (match(VecOp, m_BitCast(m_Value(VecSrc))) && 1038 match(ScalarOp, m_BitCast(m_Value(ScalarSrc))) && 1039 (VecOp->hasOneUse() || ScalarOp->hasOneUse()) && 1040 VecSrc->getType()->isVectorTy() && !ScalarSrc->getType()->isVectorTy() && 1041 VecSrc->getType()->getVectorElementType() == ScalarSrc->getType()) { 1042 // inselt (bitcast VecSrc), (bitcast ScalarSrc), IdxOp --> 1043 // bitcast (inselt VecSrc, ScalarSrc, IdxOp) 1044 Value *NewInsElt = Builder.CreateInsertElement(VecSrc, ScalarSrc, IdxOp); 1045 return new BitCastInst(NewInsElt, IE.getType()); 1046 } 1047 1048 // If the inserted element was extracted from some other vector and both 1049 // indexes are valid constants, try to turn this into a shuffle. 1050 uint64_t InsertedIdx, ExtractedIdx; 1051 Value *ExtVecOp; 1052 if (match(IdxOp, m_ConstantInt(InsertedIdx)) && 1053 match(ScalarOp, m_ExtractElement(m_Value(ExtVecOp), 1054 m_ConstantInt(ExtractedIdx))) && 1055 ExtractedIdx < ExtVecOp->getType()->getVectorNumElements()) { 1056 // TODO: Looking at the user(s) to determine if this insert is a 1057 // fold-to-shuffle opportunity does not match the usual instcombine 1058 // constraints. We should decide if the transform is worthy based only 1059 // on this instruction and its operands, but that may not work currently. 1060 // 1061 // Here, we are trying to avoid creating shuffles before reaching 1062 // the end of a chain of extract-insert pairs. This is complicated because 1063 // we do not generally form arbitrary shuffle masks in instcombine 1064 // (because those may codegen poorly), but collectShuffleElements() does 1065 // exactly that. 1066 // 1067 // The rules for determining what is an acceptable target-independent 1068 // shuffle mask are fuzzy because they evolve based on the backend's 1069 // capabilities and real-world impact. 1070 auto isShuffleRootCandidate = [](InsertElementInst &Insert) { 1071 if (!Insert.hasOneUse()) 1072 return true; 1073 auto *InsertUser = dyn_cast<InsertElementInst>(Insert.user_back()); 1074 if (!InsertUser) 1075 return true; 1076 return false; 1077 }; 1078 1079 // Try to form a shuffle from a chain of extract-insert ops. 1080 if (isShuffleRootCandidate(IE)) { 1081 SmallVector<Constant*, 16> Mask; 1082 ShuffleOps LR = collectShuffleElements(&IE, Mask, nullptr, *this); 1083 1084 // The proposed shuffle may be trivial, in which case we shouldn't 1085 // perform the combine. 1086 if (LR.first != &IE && LR.second != &IE) { 1087 // We now have a shuffle of LHS, RHS, Mask. 1088 if (LR.second == nullptr) 1089 LR.second = UndefValue::get(LR.first->getType()); 1090 return new ShuffleVectorInst(LR.first, LR.second, 1091 ConstantVector::get(Mask)); 1092 } 1093 } 1094 } 1095 1096 unsigned VWidth = VecOp->getType()->getVectorNumElements(); 1097 APInt UndefElts(VWidth, 0); 1098 APInt AllOnesEltMask(APInt::getAllOnesValue(VWidth)); 1099 if (Value *V = SimplifyDemandedVectorElts(&IE, AllOnesEltMask, UndefElts)) { 1100 if (V != &IE) 1101 return replaceInstUsesWith(IE, V); 1102 return &IE; 1103 } 1104 1105 if (Instruction *Shuf = foldConstantInsEltIntoShuffle(IE)) 1106 return Shuf; 1107 1108 if (Instruction *NewInsElt = hoistInsEltConst(IE, Builder)) 1109 return NewInsElt; 1110 1111 if (Instruction *Broadcast = foldInsSequenceIntoSplat(IE)) 1112 return Broadcast; 1113 1114 if (Instruction *Splat = foldInsEltIntoSplat(IE)) 1115 return Splat; 1116 1117 if (Instruction *IdentityShuf = foldInsEltIntoIdentityShuffle(IE)) 1118 return IdentityShuf; 1119 1120 return nullptr; 1121 } 1122 1123 /// Return true if we can evaluate the specified expression tree if the vector 1124 /// elements were shuffled in a different order. 1125 static bool canEvaluateShuffled(Value *V, ArrayRef<int> Mask, 1126 unsigned Depth = 5) { 1127 // We can always reorder the elements of a constant. 1128 if (isa<Constant>(V)) 1129 return true; 1130 1131 // We won't reorder vector arguments. No IPO here. 1132 Instruction *I = dyn_cast<Instruction>(V); 1133 if (!I) return false; 1134 1135 // Two users may expect different orders of the elements. Don't try it. 1136 if (!I->hasOneUse()) 1137 return false; 1138 1139 if (Depth == 0) return false; 1140 1141 switch (I->getOpcode()) { 1142 case Instruction::UDiv: 1143 case Instruction::SDiv: 1144 case Instruction::URem: 1145 case Instruction::SRem: 1146 // Propagating an undefined shuffle mask element to integer div/rem is not 1147 // allowed because those opcodes can create immediate undefined behavior 1148 // from an undefined element in an operand. 1149 if (llvm::any_of(Mask, [](int M){ return M == -1; })) 1150 return false; 1151 LLVM_FALLTHROUGH; 1152 case Instruction::Add: 1153 case Instruction::FAdd: 1154 case Instruction::Sub: 1155 case Instruction::FSub: 1156 case Instruction::Mul: 1157 case Instruction::FMul: 1158 case Instruction::FDiv: 1159 case Instruction::FRem: 1160 case Instruction::Shl: 1161 case Instruction::LShr: 1162 case Instruction::AShr: 1163 case Instruction::And: 1164 case Instruction::Or: 1165 case Instruction::Xor: 1166 case Instruction::ICmp: 1167 case Instruction::FCmp: 1168 case Instruction::Trunc: 1169 case Instruction::ZExt: 1170 case Instruction::SExt: 1171 case Instruction::FPToUI: 1172 case Instruction::FPToSI: 1173 case Instruction::UIToFP: 1174 case Instruction::SIToFP: 1175 case Instruction::FPTrunc: 1176 case Instruction::FPExt: 1177 case Instruction::GetElementPtr: { 1178 // Bail out if we would create longer vector ops. We could allow creating 1179 // longer vector ops, but that may result in more expensive codegen. 1180 Type *ITy = I->getType(); 1181 if (ITy->isVectorTy() && Mask.size() > ITy->getVectorNumElements()) 1182 return false; 1183 for (Value *Operand : I->operands()) { 1184 if (!canEvaluateShuffled(Operand, Mask, Depth - 1)) 1185 return false; 1186 } 1187 return true; 1188 } 1189 case Instruction::InsertElement: { 1190 ConstantInt *CI = dyn_cast<ConstantInt>(I->getOperand(2)); 1191 if (!CI) return false; 1192 int ElementNumber = CI->getLimitedValue(); 1193 1194 // Verify that 'CI' does not occur twice in Mask. A single 'insertelement' 1195 // can't put an element into multiple indices. 1196 bool SeenOnce = false; 1197 for (int i = 0, e = Mask.size(); i != e; ++i) { 1198 if (Mask[i] == ElementNumber) { 1199 if (SeenOnce) 1200 return false; 1201 SeenOnce = true; 1202 } 1203 } 1204 return canEvaluateShuffled(I->getOperand(0), Mask, Depth - 1); 1205 } 1206 } 1207 return false; 1208 } 1209 1210 /// Rebuild a new instruction just like 'I' but with the new operands given. 1211 /// In the event of type mismatch, the type of the operands is correct. 1212 static Value *buildNew(Instruction *I, ArrayRef<Value*> NewOps) { 1213 // We don't want to use the IRBuilder here because we want the replacement 1214 // instructions to appear next to 'I', not the builder's insertion point. 1215 switch (I->getOpcode()) { 1216 case Instruction::Add: 1217 case Instruction::FAdd: 1218 case Instruction::Sub: 1219 case Instruction::FSub: 1220 case Instruction::Mul: 1221 case Instruction::FMul: 1222 case Instruction::UDiv: 1223 case Instruction::SDiv: 1224 case Instruction::FDiv: 1225 case Instruction::URem: 1226 case Instruction::SRem: 1227 case Instruction::FRem: 1228 case Instruction::Shl: 1229 case Instruction::LShr: 1230 case Instruction::AShr: 1231 case Instruction::And: 1232 case Instruction::Or: 1233 case Instruction::Xor: { 1234 BinaryOperator *BO = cast<BinaryOperator>(I); 1235 assert(NewOps.size() == 2 && "binary operator with #ops != 2"); 1236 BinaryOperator *New = 1237 BinaryOperator::Create(cast<BinaryOperator>(I)->getOpcode(), 1238 NewOps[0], NewOps[1], "", BO); 1239 if (isa<OverflowingBinaryOperator>(BO)) { 1240 New->setHasNoUnsignedWrap(BO->hasNoUnsignedWrap()); 1241 New->setHasNoSignedWrap(BO->hasNoSignedWrap()); 1242 } 1243 if (isa<PossiblyExactOperator>(BO)) { 1244 New->setIsExact(BO->isExact()); 1245 } 1246 if (isa<FPMathOperator>(BO)) 1247 New->copyFastMathFlags(I); 1248 return New; 1249 } 1250 case Instruction::ICmp: 1251 assert(NewOps.size() == 2 && "icmp with #ops != 2"); 1252 return new ICmpInst(I, cast<ICmpInst>(I)->getPredicate(), 1253 NewOps[0], NewOps[1]); 1254 case Instruction::FCmp: 1255 assert(NewOps.size() == 2 && "fcmp with #ops != 2"); 1256 return new FCmpInst(I, cast<FCmpInst>(I)->getPredicate(), 1257 NewOps[0], NewOps[1]); 1258 case Instruction::Trunc: 1259 case Instruction::ZExt: 1260 case Instruction::SExt: 1261 case Instruction::FPToUI: 1262 case Instruction::FPToSI: 1263 case Instruction::UIToFP: 1264 case Instruction::SIToFP: 1265 case Instruction::FPTrunc: 1266 case Instruction::FPExt: { 1267 // It's possible that the mask has a different number of elements from 1268 // the original cast. We recompute the destination type to match the mask. 1269 Type *DestTy = 1270 VectorType::get(I->getType()->getScalarType(), 1271 NewOps[0]->getType()->getVectorNumElements()); 1272 assert(NewOps.size() == 1 && "cast with #ops != 1"); 1273 return CastInst::Create(cast<CastInst>(I)->getOpcode(), NewOps[0], DestTy, 1274 "", I); 1275 } 1276 case Instruction::GetElementPtr: { 1277 Value *Ptr = NewOps[0]; 1278 ArrayRef<Value*> Idx = NewOps.slice(1); 1279 GetElementPtrInst *GEP = GetElementPtrInst::Create( 1280 cast<GetElementPtrInst>(I)->getSourceElementType(), Ptr, Idx, "", I); 1281 GEP->setIsInBounds(cast<GetElementPtrInst>(I)->isInBounds()); 1282 return GEP; 1283 } 1284 } 1285 llvm_unreachable("failed to rebuild vector instructions"); 1286 } 1287 1288 static Value *evaluateInDifferentElementOrder(Value *V, ArrayRef<int> Mask) { 1289 // Mask.size() does not need to be equal to the number of vector elements. 1290 1291 assert(V->getType()->isVectorTy() && "can't reorder non-vector elements"); 1292 Type *EltTy = V->getType()->getScalarType(); 1293 Type *I32Ty = IntegerType::getInt32Ty(V->getContext()); 1294 if (isa<UndefValue>(V)) 1295 return UndefValue::get(VectorType::get(EltTy, Mask.size())); 1296 1297 if (isa<ConstantAggregateZero>(V)) 1298 return ConstantAggregateZero::get(VectorType::get(EltTy, Mask.size())); 1299 1300 if (Constant *C = dyn_cast<Constant>(V)) { 1301 SmallVector<Constant *, 16> MaskValues; 1302 for (int i = 0, e = Mask.size(); i != e; ++i) { 1303 if (Mask[i] == -1) 1304 MaskValues.push_back(UndefValue::get(I32Ty)); 1305 else 1306 MaskValues.push_back(ConstantInt::get(I32Ty, Mask[i])); 1307 } 1308 return ConstantExpr::getShuffleVector(C, UndefValue::get(C->getType()), 1309 ConstantVector::get(MaskValues)); 1310 } 1311 1312 Instruction *I = cast<Instruction>(V); 1313 switch (I->getOpcode()) { 1314 case Instruction::Add: 1315 case Instruction::FAdd: 1316 case Instruction::Sub: 1317 case Instruction::FSub: 1318 case Instruction::Mul: 1319 case Instruction::FMul: 1320 case Instruction::UDiv: 1321 case Instruction::SDiv: 1322 case Instruction::FDiv: 1323 case Instruction::URem: 1324 case Instruction::SRem: 1325 case Instruction::FRem: 1326 case Instruction::Shl: 1327 case Instruction::LShr: 1328 case Instruction::AShr: 1329 case Instruction::And: 1330 case Instruction::Or: 1331 case Instruction::Xor: 1332 case Instruction::ICmp: 1333 case Instruction::FCmp: 1334 case Instruction::Trunc: 1335 case Instruction::ZExt: 1336 case Instruction::SExt: 1337 case Instruction::FPToUI: 1338 case Instruction::FPToSI: 1339 case Instruction::UIToFP: 1340 case Instruction::SIToFP: 1341 case Instruction::FPTrunc: 1342 case Instruction::FPExt: 1343 case Instruction::Select: 1344 case Instruction::GetElementPtr: { 1345 SmallVector<Value*, 8> NewOps; 1346 bool NeedsRebuild = (Mask.size() != I->getType()->getVectorNumElements()); 1347 for (int i = 0, e = I->getNumOperands(); i != e; ++i) { 1348 Value *V; 1349 // Recursively call evaluateInDifferentElementOrder on vector arguments 1350 // as well. E.g. GetElementPtr may have scalar operands even if the 1351 // return value is a vector, so we need to examine the operand type. 1352 if (I->getOperand(i)->getType()->isVectorTy()) 1353 V = evaluateInDifferentElementOrder(I->getOperand(i), Mask); 1354 else 1355 V = I->getOperand(i); 1356 NewOps.push_back(V); 1357 NeedsRebuild |= (V != I->getOperand(i)); 1358 } 1359 if (NeedsRebuild) { 1360 return buildNew(I, NewOps); 1361 } 1362 return I; 1363 } 1364 case Instruction::InsertElement: { 1365 int Element = cast<ConstantInt>(I->getOperand(2))->getLimitedValue(); 1366 1367 // The insertelement was inserting at Element. Figure out which element 1368 // that becomes after shuffling. The answer is guaranteed to be unique 1369 // by CanEvaluateShuffled. 1370 bool Found = false; 1371 int Index = 0; 1372 for (int e = Mask.size(); Index != e; ++Index) { 1373 if (Mask[Index] == Element) { 1374 Found = true; 1375 break; 1376 } 1377 } 1378 1379 // If element is not in Mask, no need to handle the operand 1 (element to 1380 // be inserted). Just evaluate values in operand 0 according to Mask. 1381 if (!Found) 1382 return evaluateInDifferentElementOrder(I->getOperand(0), Mask); 1383 1384 Value *V = evaluateInDifferentElementOrder(I->getOperand(0), Mask); 1385 return InsertElementInst::Create(V, I->getOperand(1), 1386 ConstantInt::get(I32Ty, Index), "", I); 1387 } 1388 } 1389 llvm_unreachable("failed to reorder elements of vector instruction!"); 1390 } 1391 1392 // Returns true if the shuffle is extracting a contiguous range of values from 1393 // LHS, for example: 1394 // +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+ 1395 // Input: |AA|BB|CC|DD|EE|FF|GG|HH|II|JJ|KK|LL|MM|NN|OO|PP| 1396 // Shuffles to: |EE|FF|GG|HH| 1397 // +--+--+--+--+ 1398 static bool isShuffleExtractingFromLHS(ShuffleVectorInst &SVI, 1399 SmallVector<int, 16> &Mask) { 1400 unsigned LHSElems = SVI.getOperand(0)->getType()->getVectorNumElements(); 1401 unsigned MaskElems = Mask.size(); 1402 unsigned BegIdx = Mask.front(); 1403 unsigned EndIdx = Mask.back(); 1404 if (BegIdx > EndIdx || EndIdx >= LHSElems || EndIdx - BegIdx != MaskElems - 1) 1405 return false; 1406 for (unsigned I = 0; I != MaskElems; ++I) 1407 if (static_cast<unsigned>(Mask[I]) != BegIdx + I) 1408 return false; 1409 return true; 1410 } 1411 1412 /// These are the ingredients in an alternate form binary operator as described 1413 /// below. 1414 struct BinopElts { 1415 BinaryOperator::BinaryOps Opcode; 1416 Value *Op0; 1417 Value *Op1; 1418 BinopElts(BinaryOperator::BinaryOps Opc = (BinaryOperator::BinaryOps)0, 1419 Value *V0 = nullptr, Value *V1 = nullptr) : 1420 Opcode(Opc), Op0(V0), Op1(V1) {} 1421 operator bool() const { return Opcode != 0; } 1422 }; 1423 1424 /// Binops may be transformed into binops with different opcodes and operands. 1425 /// Reverse the usual canonicalization to enable folds with the non-canonical 1426 /// form of the binop. If a transform is possible, return the elements of the 1427 /// new binop. If not, return invalid elements. 1428 static BinopElts getAlternateBinop(BinaryOperator *BO, const DataLayout &DL) { 1429 Value *BO0 = BO->getOperand(0), *BO1 = BO->getOperand(1); 1430 Type *Ty = BO->getType(); 1431 switch (BO->getOpcode()) { 1432 case Instruction::Shl: { 1433 // shl X, C --> mul X, (1 << C) 1434 Constant *C; 1435 if (match(BO1, m_Constant(C))) { 1436 Constant *ShlOne = ConstantExpr::getShl(ConstantInt::get(Ty, 1), C); 1437 return { Instruction::Mul, BO0, ShlOne }; 1438 } 1439 break; 1440 } 1441 case Instruction::Or: { 1442 // or X, C --> add X, C (when X and C have no common bits set) 1443 const APInt *C; 1444 if (match(BO1, m_APInt(C)) && MaskedValueIsZero(BO0, *C, DL)) 1445 return { Instruction::Add, BO0, BO1 }; 1446 break; 1447 } 1448 default: 1449 break; 1450 } 1451 return {}; 1452 } 1453 1454 static Instruction *foldSelectShuffleWith1Binop(ShuffleVectorInst &Shuf) { 1455 assert(Shuf.isSelect() && "Must have select-equivalent shuffle"); 1456 1457 // Are we shuffling together some value and that same value after it has been 1458 // modified by a binop with a constant? 1459 Value *Op0 = Shuf.getOperand(0), *Op1 = Shuf.getOperand(1); 1460 Constant *C; 1461 bool Op0IsBinop; 1462 if (match(Op0, m_BinOp(m_Specific(Op1), m_Constant(C)))) 1463 Op0IsBinop = true; 1464 else if (match(Op1, m_BinOp(m_Specific(Op0), m_Constant(C)))) 1465 Op0IsBinop = false; 1466 else 1467 return nullptr; 1468 1469 // The identity constant for a binop leaves a variable operand unchanged. For 1470 // a vector, this is a splat of something like 0, -1, or 1. 1471 // If there's no identity constant for this binop, we're done. 1472 auto *BO = cast<BinaryOperator>(Op0IsBinop ? Op0 : Op1); 1473 BinaryOperator::BinaryOps BOpcode = BO->getOpcode(); 1474 Constant *IdC = ConstantExpr::getBinOpIdentity(BOpcode, Shuf.getType(), true); 1475 if (!IdC) 1476 return nullptr; 1477 1478 // Shuffle identity constants into the lanes that return the original value. 1479 // Example: shuf (mul X, {-1,-2,-3,-4}), X, {0,5,6,3} --> mul X, {-1,1,1,-4} 1480 // Example: shuf X, (add X, {-1,-2,-3,-4}), {0,1,6,7} --> add X, {0,0,-3,-4} 1481 // The existing binop constant vector remains in the same operand position. 1482 Constant *Mask = Shuf.getMask(); 1483 Constant *NewC = Op0IsBinop ? ConstantExpr::getShuffleVector(C, IdC, Mask) : 1484 ConstantExpr::getShuffleVector(IdC, C, Mask); 1485 1486 bool MightCreatePoisonOrUB = 1487 Mask->containsUndefElement() && 1488 (Instruction::isIntDivRem(BOpcode) || Instruction::isShift(BOpcode)); 1489 if (MightCreatePoisonOrUB) 1490 NewC = getSafeVectorConstantForBinop(BOpcode, NewC, true); 1491 1492 // shuf (bop X, C), X, M --> bop X, C' 1493 // shuf X, (bop X, C), M --> bop X, C' 1494 Value *X = Op0IsBinop ? Op1 : Op0; 1495 Instruction *NewBO = BinaryOperator::Create(BOpcode, X, NewC); 1496 NewBO->copyIRFlags(BO); 1497 1498 // An undef shuffle mask element may propagate as an undef constant element in 1499 // the new binop. That would produce poison where the original code might not. 1500 // If we already made a safe constant, then there's no danger. 1501 if (Mask->containsUndefElement() && !MightCreatePoisonOrUB) 1502 NewBO->dropPoisonGeneratingFlags(); 1503 return NewBO; 1504 } 1505 1506 /// If we have an insert of a scalar to a non-zero element of an undefined 1507 /// vector and then shuffle that value, that's the same as inserting to the zero 1508 /// element and shuffling. Splatting from the zero element is recognized as the 1509 /// canonical form of splat. 1510 static Instruction *canonicalizeInsertSplat(ShuffleVectorInst &Shuf, 1511 InstCombiner::BuilderTy &Builder) { 1512 Value *Op0 = Shuf.getOperand(0), *Op1 = Shuf.getOperand(1); 1513 Constant *Mask = Shuf.getMask(); 1514 Value *X; 1515 uint64_t IndexC; 1516 1517 // Match a shuffle that is a splat to a non-zero element. 1518 if (!match(Op0, m_OneUse(m_InsertElement(m_Undef(), m_Value(X), 1519 m_ConstantInt(IndexC)))) || 1520 !match(Op1, m_Undef()) || match(Mask, m_ZeroInt()) || IndexC == 0) 1521 return nullptr; 1522 1523 // Insert into element 0 of an undef vector. 1524 UndefValue *UndefVec = UndefValue::get(Shuf.getType()); 1525 Constant *Zero = Builder.getInt32(0); 1526 Value *NewIns = Builder.CreateInsertElement(UndefVec, X, Zero); 1527 1528 // Splat from element 0. Any mask element that is undefined remains undefined. 1529 // For example: 1530 // shuf (inselt undef, X, 2), undef, <2,2,undef> 1531 // --> shuf (inselt undef, X, 0), undef, <0,0,undef> 1532 unsigned NumMaskElts = Shuf.getType()->getVectorNumElements(); 1533 SmallVector<Constant *, 16> NewMask(NumMaskElts, Zero); 1534 for (unsigned i = 0; i != NumMaskElts; ++i) 1535 if (isa<UndefValue>(Mask->getAggregateElement(i))) 1536 NewMask[i] = Mask->getAggregateElement(i); 1537 1538 return new ShuffleVectorInst(NewIns, UndefVec, ConstantVector::get(NewMask)); 1539 } 1540 1541 /// Try to fold shuffles that are the equivalent of a vector select. 1542 static Instruction *foldSelectShuffle(ShuffleVectorInst &Shuf, 1543 InstCombiner::BuilderTy &Builder, 1544 const DataLayout &DL) { 1545 if (!Shuf.isSelect()) 1546 return nullptr; 1547 1548 // Canonicalize to choose from operand 0 first unless operand 1 is undefined. 1549 // Commuting undef to operand 0 conflicts with another canonicalization. 1550 unsigned NumElts = Shuf.getType()->getVectorNumElements(); 1551 if (!isa<UndefValue>(Shuf.getOperand(1)) && 1552 Shuf.getMaskValue(0) >= (int)NumElts) { 1553 // TODO: Can we assert that both operands of a shuffle-select are not undef 1554 // (otherwise, it would have been folded by instsimplify? 1555 Shuf.commute(); 1556 return &Shuf; 1557 } 1558 1559 if (Instruction *I = foldSelectShuffleWith1Binop(Shuf)) 1560 return I; 1561 1562 BinaryOperator *B0, *B1; 1563 if (!match(Shuf.getOperand(0), m_BinOp(B0)) || 1564 !match(Shuf.getOperand(1), m_BinOp(B1))) 1565 return nullptr; 1566 1567 Value *X, *Y; 1568 Constant *C0, *C1; 1569 bool ConstantsAreOp1; 1570 if (match(B0, m_BinOp(m_Value(X), m_Constant(C0))) && 1571 match(B1, m_BinOp(m_Value(Y), m_Constant(C1)))) 1572 ConstantsAreOp1 = true; 1573 else if (match(B0, m_BinOp(m_Constant(C0), m_Value(X))) && 1574 match(B1, m_BinOp(m_Constant(C1), m_Value(Y)))) 1575 ConstantsAreOp1 = false; 1576 else 1577 return nullptr; 1578 1579 // We need matching binops to fold the lanes together. 1580 BinaryOperator::BinaryOps Opc0 = B0->getOpcode(); 1581 BinaryOperator::BinaryOps Opc1 = B1->getOpcode(); 1582 bool DropNSW = false; 1583 if (ConstantsAreOp1 && Opc0 != Opc1) { 1584 // TODO: We drop "nsw" if shift is converted into multiply because it may 1585 // not be correct when the shift amount is BitWidth - 1. We could examine 1586 // each vector element to determine if it is safe to keep that flag. 1587 if (Opc0 == Instruction::Shl || Opc1 == Instruction::Shl) 1588 DropNSW = true; 1589 if (BinopElts AltB0 = getAlternateBinop(B0, DL)) { 1590 assert(isa<Constant>(AltB0.Op1) && "Expecting constant with alt binop"); 1591 Opc0 = AltB0.Opcode; 1592 C0 = cast<Constant>(AltB0.Op1); 1593 } else if (BinopElts AltB1 = getAlternateBinop(B1, DL)) { 1594 assert(isa<Constant>(AltB1.Op1) && "Expecting constant with alt binop"); 1595 Opc1 = AltB1.Opcode; 1596 C1 = cast<Constant>(AltB1.Op1); 1597 } 1598 } 1599 1600 if (Opc0 != Opc1) 1601 return nullptr; 1602 1603 // The opcodes must be the same. Use a new name to make that clear. 1604 BinaryOperator::BinaryOps BOpc = Opc0; 1605 1606 // Select the constant elements needed for the single binop. 1607 Constant *Mask = Shuf.getMask(); 1608 Constant *NewC = ConstantExpr::getShuffleVector(C0, C1, Mask); 1609 1610 // We are moving a binop after a shuffle. When a shuffle has an undefined 1611 // mask element, the result is undefined, but it is not poison or undefined 1612 // behavior. That is not necessarily true for div/rem/shift. 1613 bool MightCreatePoisonOrUB = 1614 Mask->containsUndefElement() && 1615 (Instruction::isIntDivRem(BOpc) || Instruction::isShift(BOpc)); 1616 if (MightCreatePoisonOrUB) 1617 NewC = getSafeVectorConstantForBinop(BOpc, NewC, ConstantsAreOp1); 1618 1619 Value *V; 1620 if (X == Y) { 1621 // Remove a binop and the shuffle by rearranging the constant: 1622 // shuffle (op V, C0), (op V, C1), M --> op V, C' 1623 // shuffle (op C0, V), (op C1, V), M --> op C', V 1624 V = X; 1625 } else { 1626 // If there are 2 different variable operands, we must create a new shuffle 1627 // (select) first, so check uses to ensure that we don't end up with more 1628 // instructions than we started with. 1629 if (!B0->hasOneUse() && !B1->hasOneUse()) 1630 return nullptr; 1631 1632 // If we use the original shuffle mask and op1 is *variable*, we would be 1633 // putting an undef into operand 1 of div/rem/shift. This is either UB or 1634 // poison. We do not have to guard against UB when *constants* are op1 1635 // because safe constants guarantee that we do not overflow sdiv/srem (and 1636 // there's no danger for other opcodes). 1637 // TODO: To allow this case, create a new shuffle mask with no undefs. 1638 if (MightCreatePoisonOrUB && !ConstantsAreOp1) 1639 return nullptr; 1640 1641 // Note: In general, we do not create new shuffles in InstCombine because we 1642 // do not know if a target can lower an arbitrary shuffle optimally. In this 1643 // case, the shuffle uses the existing mask, so there is no additional risk. 1644 1645 // Select the variable vectors first, then perform the binop: 1646 // shuffle (op X, C0), (op Y, C1), M --> op (shuffle X, Y, M), C' 1647 // shuffle (op C0, X), (op C1, Y), M --> op C', (shuffle X, Y, M) 1648 V = Builder.CreateShuffleVector(X, Y, Mask); 1649 } 1650 1651 Instruction *NewBO = ConstantsAreOp1 ? BinaryOperator::Create(BOpc, V, NewC) : 1652 BinaryOperator::Create(BOpc, NewC, V); 1653 1654 // Flags are intersected from the 2 source binops. But there are 2 exceptions: 1655 // 1. If we changed an opcode, poison conditions might have changed. 1656 // 2. If the shuffle had undef mask elements, the new binop might have undefs 1657 // where the original code did not. But if we already made a safe constant, 1658 // then there's no danger. 1659 NewBO->copyIRFlags(B0); 1660 NewBO->andIRFlags(B1); 1661 if (DropNSW) 1662 NewBO->setHasNoSignedWrap(false); 1663 if (Mask->containsUndefElement() && !MightCreatePoisonOrUB) 1664 NewBO->dropPoisonGeneratingFlags(); 1665 return NewBO; 1666 } 1667 1668 /// Match a shuffle-select-shuffle pattern where the shuffles are widening and 1669 /// narrowing (concatenating with undef and extracting back to the original 1670 /// length). This allows replacing the wide select with a narrow select. 1671 static Instruction *narrowVectorSelect(ShuffleVectorInst &Shuf, 1672 InstCombiner::BuilderTy &Builder) { 1673 // This must be a narrowing identity shuffle. It extracts the 1st N elements 1674 // of the 1st vector operand of a shuffle. 1675 if (!match(Shuf.getOperand(1), m_Undef()) || !Shuf.isIdentityWithExtract()) 1676 return nullptr; 1677 1678 // The vector being shuffled must be a vector select that we can eliminate. 1679 // TODO: The one-use requirement could be eased if X and/or Y are constants. 1680 Value *Cond, *X, *Y; 1681 if (!match(Shuf.getOperand(0), 1682 m_OneUse(m_Select(m_Value(Cond), m_Value(X), m_Value(Y))))) 1683 return nullptr; 1684 1685 // We need a narrow condition value. It must be extended with undef elements 1686 // and have the same number of elements as this shuffle. 1687 unsigned NarrowNumElts = Shuf.getType()->getVectorNumElements(); 1688 Value *NarrowCond; 1689 if (!match(Cond, m_OneUse(m_ShuffleVector(m_Value(NarrowCond), m_Undef(), 1690 m_Constant()))) || 1691 NarrowCond->getType()->getVectorNumElements() != NarrowNumElts || 1692 !cast<ShuffleVectorInst>(Cond)->isIdentityWithPadding()) 1693 return nullptr; 1694 1695 // shuf (sel (shuf NarrowCond, undef, WideMask), X, Y), undef, NarrowMask) --> 1696 // sel NarrowCond, (shuf X, undef, NarrowMask), (shuf Y, undef, NarrowMask) 1697 Value *Undef = UndefValue::get(X->getType()); 1698 Value *NarrowX = Builder.CreateShuffleVector(X, Undef, Shuf.getMask()); 1699 Value *NarrowY = Builder.CreateShuffleVector(Y, Undef, Shuf.getMask()); 1700 return SelectInst::Create(NarrowCond, NarrowX, NarrowY); 1701 } 1702 1703 /// Try to combine 2 shuffles into 1 shuffle by concatenating a shuffle mask. 1704 static Instruction *foldIdentityExtractShuffle(ShuffleVectorInst &Shuf) { 1705 Value *Op0 = Shuf.getOperand(0), *Op1 = Shuf.getOperand(1); 1706 if (!Shuf.isIdentityWithExtract() || !isa<UndefValue>(Op1)) 1707 return nullptr; 1708 1709 Value *X, *Y; 1710 Constant *Mask; 1711 if (!match(Op0, m_ShuffleVector(m_Value(X), m_Value(Y), m_Constant(Mask)))) 1712 return nullptr; 1713 1714 // Be conservative with shuffle transforms. If we can't kill the 1st shuffle, 1715 // then combining may result in worse codegen. 1716 if (!Op0->hasOneUse()) 1717 return nullptr; 1718 1719 // We are extracting a subvector from a shuffle. Remove excess elements from 1720 // the 1st shuffle mask to eliminate the extract. 1721 // 1722 // This transform is conservatively limited to identity extracts because we do 1723 // not allow arbitrary shuffle mask creation as a target-independent transform 1724 // (because we can't guarantee that will lower efficiently). 1725 // 1726 // If the extracting shuffle has an undef mask element, it transfers to the 1727 // new shuffle mask. Otherwise, copy the original mask element. Example: 1728 // shuf (shuf X, Y, <C0, C1, C2, undef, C4>), undef, <0, undef, 2, 3> --> 1729 // shuf X, Y, <C0, undef, C2, undef> 1730 unsigned NumElts = Shuf.getType()->getVectorNumElements(); 1731 SmallVector<Constant *, 16> NewMask(NumElts); 1732 assert(NumElts < Mask->getType()->getVectorNumElements() && 1733 "Identity with extract must have less elements than its inputs"); 1734 1735 for (unsigned i = 0; i != NumElts; ++i) { 1736 Constant *ExtractMaskElt = Shuf.getMask()->getAggregateElement(i); 1737 Constant *MaskElt = Mask->getAggregateElement(i); 1738 NewMask[i] = isa<UndefValue>(ExtractMaskElt) ? ExtractMaskElt : MaskElt; 1739 } 1740 return new ShuffleVectorInst(X, Y, ConstantVector::get(NewMask)); 1741 } 1742 1743 /// Try to replace a shuffle with an insertelement or try to replace a shuffle 1744 /// operand with the operand of an insertelement. 1745 static Instruction *foldShuffleWithInsert(ShuffleVectorInst &Shuf) { 1746 Value *V0 = Shuf.getOperand(0), *V1 = Shuf.getOperand(1); 1747 SmallVector<int, 16> Mask = Shuf.getShuffleMask(); 1748 1749 // The shuffle must not change vector sizes. 1750 // TODO: This restriction could be removed if the insert has only one use 1751 // (because the transform would require a new length-changing shuffle). 1752 int NumElts = Mask.size(); 1753 if (NumElts != (int)(V0->getType()->getVectorNumElements())) 1754 return nullptr; 1755 1756 // This is a specialization of a fold in SimplifyDemandedVectorElts. We may 1757 // not be able to handle it there if the insertelement has >1 use. 1758 // If the shuffle has an insertelement operand but does not choose the 1759 // inserted scalar element from that value, then we can replace that shuffle 1760 // operand with the source vector of the insertelement. 1761 Value *X; 1762 uint64_t IdxC; 1763 if (match(V0, m_InsertElement(m_Value(X), m_Value(), m_ConstantInt(IdxC)))) { 1764 // shuf (inselt X, ?, IdxC), ?, Mask --> shuf X, ?, Mask 1765 if (none_of(Mask, [IdxC](int MaskElt) { return MaskElt == (int)IdxC; })) { 1766 Shuf.setOperand(0, X); 1767 return &Shuf; 1768 } 1769 } 1770 if (match(V1, m_InsertElement(m_Value(X), m_Value(), m_ConstantInt(IdxC)))) { 1771 // Offset the index constant by the vector width because we are checking for 1772 // accesses to the 2nd vector input of the shuffle. 1773 IdxC += NumElts; 1774 // shuf ?, (inselt X, ?, IdxC), Mask --> shuf ?, X, Mask 1775 if (none_of(Mask, [IdxC](int MaskElt) { return MaskElt == (int)IdxC; })) { 1776 Shuf.setOperand(1, X); 1777 return &Shuf; 1778 } 1779 } 1780 1781 // shuffle (insert ?, Scalar, IndexC), V1, Mask --> insert V1, Scalar, IndexC' 1782 auto isShufflingScalarIntoOp1 = [&](Value *&Scalar, ConstantInt *&IndexC) { 1783 // We need an insertelement with a constant index. 1784 if (!match(V0, m_InsertElement(m_Value(), m_Value(Scalar), 1785 m_ConstantInt(IndexC)))) 1786 return false; 1787 1788 // Test the shuffle mask to see if it splices the inserted scalar into the 1789 // operand 1 vector of the shuffle. 1790 int NewInsIndex = -1; 1791 for (int i = 0; i != NumElts; ++i) { 1792 // Ignore undef mask elements. 1793 if (Mask[i] == -1) 1794 continue; 1795 1796 // The shuffle takes elements of operand 1 without lane changes. 1797 if (Mask[i] == NumElts + i) 1798 continue; 1799 1800 // The shuffle must choose the inserted scalar exactly once. 1801 if (NewInsIndex != -1 || Mask[i] != IndexC->getSExtValue()) 1802 return false; 1803 1804 // The shuffle is placing the inserted scalar into element i. 1805 NewInsIndex = i; 1806 } 1807 1808 assert(NewInsIndex != -1 && "Did not fold shuffle with unused operand?"); 1809 1810 // Index is updated to the potentially translated insertion lane. 1811 IndexC = ConstantInt::get(IndexC->getType(), NewInsIndex); 1812 return true; 1813 }; 1814 1815 // If the shuffle is unnecessary, insert the scalar operand directly into 1816 // operand 1 of the shuffle. Example: 1817 // shuffle (insert ?, S, 1), V1, <1, 5, 6, 7> --> insert V1, S, 0 1818 Value *Scalar; 1819 ConstantInt *IndexC; 1820 if (isShufflingScalarIntoOp1(Scalar, IndexC)) 1821 return InsertElementInst::Create(V1, Scalar, IndexC); 1822 1823 // Try again after commuting shuffle. Example: 1824 // shuffle V0, (insert ?, S, 0), <0, 1, 2, 4> --> 1825 // shuffle (insert ?, S, 0), V0, <4, 5, 6, 0> --> insert V0, S, 3 1826 std::swap(V0, V1); 1827 ShuffleVectorInst::commuteShuffleMask(Mask, NumElts); 1828 if (isShufflingScalarIntoOp1(Scalar, IndexC)) 1829 return InsertElementInst::Create(V1, Scalar, IndexC); 1830 1831 return nullptr; 1832 } 1833 1834 static Instruction *foldIdentityPaddedShuffles(ShuffleVectorInst &Shuf) { 1835 // Match the operands as identity with padding (also known as concatenation 1836 // with undef) shuffles of the same source type. The backend is expected to 1837 // recreate these concatenations from a shuffle of narrow operands. 1838 auto *Shuffle0 = dyn_cast<ShuffleVectorInst>(Shuf.getOperand(0)); 1839 auto *Shuffle1 = dyn_cast<ShuffleVectorInst>(Shuf.getOperand(1)); 1840 if (!Shuffle0 || !Shuffle0->isIdentityWithPadding() || 1841 !Shuffle1 || !Shuffle1->isIdentityWithPadding()) 1842 return nullptr; 1843 1844 // We limit this transform to power-of-2 types because we expect that the 1845 // backend can convert the simplified IR patterns to identical nodes as the 1846 // original IR. 1847 // TODO: If we can verify the same behavior for arbitrary types, the 1848 // power-of-2 checks can be removed. 1849 Value *X = Shuffle0->getOperand(0); 1850 Value *Y = Shuffle1->getOperand(0); 1851 if (X->getType() != Y->getType() || 1852 !isPowerOf2_32(Shuf.getType()->getVectorNumElements()) || 1853 !isPowerOf2_32(Shuffle0->getType()->getVectorNumElements()) || 1854 !isPowerOf2_32(X->getType()->getVectorNumElements()) || 1855 isa<UndefValue>(X) || isa<UndefValue>(Y)) 1856 return nullptr; 1857 assert(isa<UndefValue>(Shuffle0->getOperand(1)) && 1858 isa<UndefValue>(Shuffle1->getOperand(1)) && 1859 "Unexpected operand for identity shuffle"); 1860 1861 // This is a shuffle of 2 widening shuffles. We can shuffle the narrow source 1862 // operands directly by adjusting the shuffle mask to account for the narrower 1863 // types: 1864 // shuf (widen X), (widen Y), Mask --> shuf X, Y, Mask' 1865 int NarrowElts = X->getType()->getVectorNumElements(); 1866 int WideElts = Shuffle0->getType()->getVectorNumElements(); 1867 assert(WideElts > NarrowElts && "Unexpected types for identity with padding"); 1868 1869 Type *I32Ty = IntegerType::getInt32Ty(Shuf.getContext()); 1870 SmallVector<int, 16> Mask = Shuf.getShuffleMask(); 1871 SmallVector<Constant *, 16> NewMask(Mask.size(), UndefValue::get(I32Ty)); 1872 for (int i = 0, e = Mask.size(); i != e; ++i) { 1873 if (Mask[i] == -1) 1874 continue; 1875 1876 // If this shuffle is choosing an undef element from 1 of the sources, that 1877 // element is undef. 1878 if (Mask[i] < WideElts) { 1879 if (Shuffle0->getMaskValue(Mask[i]) == -1) 1880 continue; 1881 } else { 1882 if (Shuffle1->getMaskValue(Mask[i] - WideElts) == -1) 1883 continue; 1884 } 1885 1886 // If this shuffle is choosing from the 1st narrow op, the mask element is 1887 // the same. If this shuffle is choosing from the 2nd narrow op, the mask 1888 // element is offset down to adjust for the narrow vector widths. 1889 if (Mask[i] < WideElts) { 1890 assert(Mask[i] < NarrowElts && "Unexpected shuffle mask"); 1891 NewMask[i] = ConstantInt::get(I32Ty, Mask[i]); 1892 } else { 1893 assert(Mask[i] < (WideElts + NarrowElts) && "Unexpected shuffle mask"); 1894 NewMask[i] = ConstantInt::get(I32Ty, Mask[i] - (WideElts - NarrowElts)); 1895 } 1896 } 1897 return new ShuffleVectorInst(X, Y, ConstantVector::get(NewMask)); 1898 } 1899 1900 Instruction *InstCombiner::visitShuffleVectorInst(ShuffleVectorInst &SVI) { 1901 Value *LHS = SVI.getOperand(0); 1902 Value *RHS = SVI.getOperand(1); 1903 if (auto *V = SimplifyShuffleVectorInst( 1904 LHS, RHS, SVI.getMask(), SVI.getType(), SQ.getWithInstruction(&SVI))) 1905 return replaceInstUsesWith(SVI, V); 1906 1907 // shuffle x, x, mask --> shuffle x, undef, mask' 1908 unsigned VWidth = SVI.getType()->getVectorNumElements(); 1909 unsigned LHSWidth = LHS->getType()->getVectorNumElements(); 1910 SmallVector<int, 16> Mask = SVI.getShuffleMask(); 1911 Type *Int32Ty = Type::getInt32Ty(SVI.getContext()); 1912 if (LHS == RHS) { 1913 assert(!isa<UndefValue>(RHS) && "Shuffle with 2 undef ops not simplified?"); 1914 // Remap any references to RHS to use LHS. 1915 SmallVector<Constant*, 16> Elts; 1916 for (unsigned i = 0; i != VWidth; ++i) { 1917 // Propagate undef elements or force mask to LHS. 1918 if (Mask[i] < 0) 1919 Elts.push_back(UndefValue::get(Int32Ty)); 1920 else 1921 Elts.push_back(ConstantInt::get(Int32Ty, Mask[i] % LHSWidth)); 1922 } 1923 SVI.setOperand(0, SVI.getOperand(1)); 1924 SVI.setOperand(1, UndefValue::get(RHS->getType())); 1925 SVI.setOperand(2, ConstantVector::get(Elts)); 1926 return &SVI; 1927 } 1928 1929 // shuffle undef, x, mask --> shuffle x, undef, mask' 1930 if (isa<UndefValue>(LHS)) { 1931 SVI.commute(); 1932 return &SVI; 1933 } 1934 1935 if (Instruction *I = canonicalizeInsertSplat(SVI, Builder)) 1936 return I; 1937 1938 if (Instruction *I = foldSelectShuffle(SVI, Builder, DL)) 1939 return I; 1940 1941 if (Instruction *I = narrowVectorSelect(SVI, Builder)) 1942 return I; 1943 1944 APInt UndefElts(VWidth, 0); 1945 APInt AllOnesEltMask(APInt::getAllOnesValue(VWidth)); 1946 if (Value *V = SimplifyDemandedVectorElts(&SVI, AllOnesEltMask, UndefElts)) { 1947 if (V != &SVI) 1948 return replaceInstUsesWith(SVI, V); 1949 return &SVI; 1950 } 1951 1952 if (Instruction *I = foldIdentityExtractShuffle(SVI)) 1953 return I; 1954 1955 // These transforms have the potential to lose undef knowledge, so they are 1956 // intentionally placed after SimplifyDemandedVectorElts(). 1957 if (Instruction *I = foldShuffleWithInsert(SVI)) 1958 return I; 1959 if (Instruction *I = foldIdentityPaddedShuffles(SVI)) 1960 return I; 1961 1962 if (isa<UndefValue>(RHS) && canEvaluateShuffled(LHS, Mask)) { 1963 Value *V = evaluateInDifferentElementOrder(LHS, Mask); 1964 return replaceInstUsesWith(SVI, V); 1965 } 1966 1967 // SROA generates shuffle+bitcast when the extracted sub-vector is bitcast to 1968 // a non-vector type. We can instead bitcast the original vector followed by 1969 // an extract of the desired element: 1970 // 1971 // %sroa = shufflevector <16 x i8> %in, <16 x i8> undef, 1972 // <4 x i32> <i32 0, i32 1, i32 2, i32 3> 1973 // %1 = bitcast <4 x i8> %sroa to i32 1974 // Becomes: 1975 // %bc = bitcast <16 x i8> %in to <4 x i32> 1976 // %ext = extractelement <4 x i32> %bc, i32 0 1977 // 1978 // If the shuffle is extracting a contiguous range of values from the input 1979 // vector then each use which is a bitcast of the extracted size can be 1980 // replaced. This will work if the vector types are compatible, and the begin 1981 // index is aligned to a value in the casted vector type. If the begin index 1982 // isn't aligned then we can shuffle the original vector (keeping the same 1983 // vector type) before extracting. 1984 // 1985 // This code will bail out if the target type is fundamentally incompatible 1986 // with vectors of the source type. 1987 // 1988 // Example of <16 x i8>, target type i32: 1989 // Index range [4,8): v-----------v Will work. 1990 // +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+ 1991 // <16 x i8>: | | | | | | | | | | | | | | | | | 1992 // <4 x i32>: | | | | | 1993 // +-----------+-----------+-----------+-----------+ 1994 // Index range [6,10): ^-----------^ Needs an extra shuffle. 1995 // Target type i40: ^--------------^ Won't work, bail. 1996 bool MadeChange = false; 1997 if (isShuffleExtractingFromLHS(SVI, Mask)) { 1998 Value *V = LHS; 1999 unsigned MaskElems = Mask.size(); 2000 VectorType *SrcTy = cast<VectorType>(V->getType()); 2001 unsigned VecBitWidth = SrcTy->getBitWidth(); 2002 unsigned SrcElemBitWidth = DL.getTypeSizeInBits(SrcTy->getElementType()); 2003 assert(SrcElemBitWidth && "vector elements must have a bitwidth"); 2004 unsigned SrcNumElems = SrcTy->getNumElements(); 2005 SmallVector<BitCastInst *, 8> BCs; 2006 DenseMap<Type *, Value *> NewBCs; 2007 for (User *U : SVI.users()) 2008 if (BitCastInst *BC = dyn_cast<BitCastInst>(U)) 2009 if (!BC->use_empty()) 2010 // Only visit bitcasts that weren't previously handled. 2011 BCs.push_back(BC); 2012 for (BitCastInst *BC : BCs) { 2013 unsigned BegIdx = Mask.front(); 2014 Type *TgtTy = BC->getDestTy(); 2015 unsigned TgtElemBitWidth = DL.getTypeSizeInBits(TgtTy); 2016 if (!TgtElemBitWidth) 2017 continue; 2018 unsigned TgtNumElems = VecBitWidth / TgtElemBitWidth; 2019 bool VecBitWidthsEqual = VecBitWidth == TgtNumElems * TgtElemBitWidth; 2020 bool BegIsAligned = 0 == ((SrcElemBitWidth * BegIdx) % TgtElemBitWidth); 2021 if (!VecBitWidthsEqual) 2022 continue; 2023 if (!VectorType::isValidElementType(TgtTy)) 2024 continue; 2025 VectorType *CastSrcTy = VectorType::get(TgtTy, TgtNumElems); 2026 if (!BegIsAligned) { 2027 // Shuffle the input so [0,NumElements) contains the output, and 2028 // [NumElems,SrcNumElems) is undef. 2029 SmallVector<Constant *, 16> ShuffleMask(SrcNumElems, 2030 UndefValue::get(Int32Ty)); 2031 for (unsigned I = 0, E = MaskElems, Idx = BegIdx; I != E; ++Idx, ++I) 2032 ShuffleMask[I] = ConstantInt::get(Int32Ty, Idx); 2033 V = Builder.CreateShuffleVector(V, UndefValue::get(V->getType()), 2034 ConstantVector::get(ShuffleMask), 2035 SVI.getName() + ".extract"); 2036 BegIdx = 0; 2037 } 2038 unsigned SrcElemsPerTgtElem = TgtElemBitWidth / SrcElemBitWidth; 2039 assert(SrcElemsPerTgtElem); 2040 BegIdx /= SrcElemsPerTgtElem; 2041 bool BCAlreadyExists = NewBCs.find(CastSrcTy) != NewBCs.end(); 2042 auto *NewBC = 2043 BCAlreadyExists 2044 ? NewBCs[CastSrcTy] 2045 : Builder.CreateBitCast(V, CastSrcTy, SVI.getName() + ".bc"); 2046 if (!BCAlreadyExists) 2047 NewBCs[CastSrcTy] = NewBC; 2048 auto *Ext = Builder.CreateExtractElement( 2049 NewBC, ConstantInt::get(Int32Ty, BegIdx), SVI.getName() + ".extract"); 2050 // The shufflevector isn't being replaced: the bitcast that used it 2051 // is. InstCombine will visit the newly-created instructions. 2052 replaceInstUsesWith(*BC, Ext); 2053 MadeChange = true; 2054 } 2055 } 2056 2057 // If the LHS is a shufflevector itself, see if we can combine it with this 2058 // one without producing an unusual shuffle. 2059 // Cases that might be simplified: 2060 // 1. 2061 // x1=shuffle(v1,v2,mask1) 2062 // x=shuffle(x1,undef,mask) 2063 // ==> 2064 // x=shuffle(v1,undef,newMask) 2065 // newMask[i] = (mask[i] < x1.size()) ? mask1[mask[i]] : -1 2066 // 2. 2067 // x1=shuffle(v1,undef,mask1) 2068 // x=shuffle(x1,x2,mask) 2069 // where v1.size() == mask1.size() 2070 // ==> 2071 // x=shuffle(v1,x2,newMask) 2072 // newMask[i] = (mask[i] < x1.size()) ? mask1[mask[i]] : mask[i] 2073 // 3. 2074 // x2=shuffle(v2,undef,mask2) 2075 // x=shuffle(x1,x2,mask) 2076 // where v2.size() == mask2.size() 2077 // ==> 2078 // x=shuffle(x1,v2,newMask) 2079 // newMask[i] = (mask[i] < x1.size()) 2080 // ? mask[i] : mask2[mask[i]-x1.size()]+x1.size() 2081 // 4. 2082 // x1=shuffle(v1,undef,mask1) 2083 // x2=shuffle(v2,undef,mask2) 2084 // x=shuffle(x1,x2,mask) 2085 // where v1.size() == v2.size() 2086 // ==> 2087 // x=shuffle(v1,v2,newMask) 2088 // newMask[i] = (mask[i] < x1.size()) 2089 // ? mask1[mask[i]] : mask2[mask[i]-x1.size()]+v1.size() 2090 // 2091 // Here we are really conservative: 2092 // we are absolutely afraid of producing a shuffle mask not in the input 2093 // program, because the code gen may not be smart enough to turn a merged 2094 // shuffle into two specific shuffles: it may produce worse code. As such, 2095 // we only merge two shuffles if the result is either a splat or one of the 2096 // input shuffle masks. In this case, merging the shuffles just removes 2097 // one instruction, which we know is safe. This is good for things like 2098 // turning: (splat(splat)) -> splat, or 2099 // merge(V[0..n], V[n+1..2n]) -> V[0..2n] 2100 ShuffleVectorInst* LHSShuffle = dyn_cast<ShuffleVectorInst>(LHS); 2101 ShuffleVectorInst* RHSShuffle = dyn_cast<ShuffleVectorInst>(RHS); 2102 if (LHSShuffle) 2103 if (!isa<UndefValue>(LHSShuffle->getOperand(1)) && !isa<UndefValue>(RHS)) 2104 LHSShuffle = nullptr; 2105 if (RHSShuffle) 2106 if (!isa<UndefValue>(RHSShuffle->getOperand(1))) 2107 RHSShuffle = nullptr; 2108 if (!LHSShuffle && !RHSShuffle) 2109 return MadeChange ? &SVI : nullptr; 2110 2111 Value* LHSOp0 = nullptr; 2112 Value* LHSOp1 = nullptr; 2113 Value* RHSOp0 = nullptr; 2114 unsigned LHSOp0Width = 0; 2115 unsigned RHSOp0Width = 0; 2116 if (LHSShuffle) { 2117 LHSOp0 = LHSShuffle->getOperand(0); 2118 LHSOp1 = LHSShuffle->getOperand(1); 2119 LHSOp0Width = LHSOp0->getType()->getVectorNumElements(); 2120 } 2121 if (RHSShuffle) { 2122 RHSOp0 = RHSShuffle->getOperand(0); 2123 RHSOp0Width = RHSOp0->getType()->getVectorNumElements(); 2124 } 2125 Value* newLHS = LHS; 2126 Value* newRHS = RHS; 2127 if (LHSShuffle) { 2128 // case 1 2129 if (isa<UndefValue>(RHS)) { 2130 newLHS = LHSOp0; 2131 newRHS = LHSOp1; 2132 } 2133 // case 2 or 4 2134 else if (LHSOp0Width == LHSWidth) { 2135 newLHS = LHSOp0; 2136 } 2137 } 2138 // case 3 or 4 2139 if (RHSShuffle && RHSOp0Width == LHSWidth) { 2140 newRHS = RHSOp0; 2141 } 2142 // case 4 2143 if (LHSOp0 == RHSOp0) { 2144 newLHS = LHSOp0; 2145 newRHS = nullptr; 2146 } 2147 2148 if (newLHS == LHS && newRHS == RHS) 2149 return MadeChange ? &SVI : nullptr; 2150 2151 SmallVector<int, 16> LHSMask; 2152 SmallVector<int, 16> RHSMask; 2153 if (newLHS != LHS) 2154 LHSMask = LHSShuffle->getShuffleMask(); 2155 if (RHSShuffle && newRHS != RHS) 2156 RHSMask = RHSShuffle->getShuffleMask(); 2157 2158 unsigned newLHSWidth = (newLHS != LHS) ? LHSOp0Width : LHSWidth; 2159 SmallVector<int, 16> newMask; 2160 bool isSplat = true; 2161 int SplatElt = -1; 2162 // Create a new mask for the new ShuffleVectorInst so that the new 2163 // ShuffleVectorInst is equivalent to the original one. 2164 for (unsigned i = 0; i < VWidth; ++i) { 2165 int eltMask; 2166 if (Mask[i] < 0) { 2167 // This element is an undef value. 2168 eltMask = -1; 2169 } else if (Mask[i] < (int)LHSWidth) { 2170 // This element is from left hand side vector operand. 2171 // 2172 // If LHS is going to be replaced (case 1, 2, or 4), calculate the 2173 // new mask value for the element. 2174 if (newLHS != LHS) { 2175 eltMask = LHSMask[Mask[i]]; 2176 // If the value selected is an undef value, explicitly specify it 2177 // with a -1 mask value. 2178 if (eltMask >= (int)LHSOp0Width && isa<UndefValue>(LHSOp1)) 2179 eltMask = -1; 2180 } else 2181 eltMask = Mask[i]; 2182 } else { 2183 // This element is from right hand side vector operand 2184 // 2185 // If the value selected is an undef value, explicitly specify it 2186 // with a -1 mask value. (case 1) 2187 if (isa<UndefValue>(RHS)) 2188 eltMask = -1; 2189 // If RHS is going to be replaced (case 3 or 4), calculate the 2190 // new mask value for the element. 2191 else if (newRHS != RHS) { 2192 eltMask = RHSMask[Mask[i]-LHSWidth]; 2193 // If the value selected is an undef value, explicitly specify it 2194 // with a -1 mask value. 2195 if (eltMask >= (int)RHSOp0Width) { 2196 assert(isa<UndefValue>(RHSShuffle->getOperand(1)) 2197 && "should have been check above"); 2198 eltMask = -1; 2199 } 2200 } else 2201 eltMask = Mask[i]-LHSWidth; 2202 2203 // If LHS's width is changed, shift the mask value accordingly. 2204 // If newRHS == nullptr, i.e. LHSOp0 == RHSOp0, we want to remap any 2205 // references from RHSOp0 to LHSOp0, so we don't need to shift the mask. 2206 // If newRHS == newLHS, we want to remap any references from newRHS to 2207 // newLHS so that we can properly identify splats that may occur due to 2208 // obfuscation across the two vectors. 2209 if (eltMask >= 0 && newRHS != nullptr && newLHS != newRHS) 2210 eltMask += newLHSWidth; 2211 } 2212 2213 // Check if this could still be a splat. 2214 if (eltMask >= 0) { 2215 if (SplatElt >= 0 && SplatElt != eltMask) 2216 isSplat = false; 2217 SplatElt = eltMask; 2218 } 2219 2220 newMask.push_back(eltMask); 2221 } 2222 2223 // If the result mask is equal to one of the original shuffle masks, 2224 // or is a splat, do the replacement. 2225 if (isSplat || newMask == LHSMask || newMask == RHSMask || newMask == Mask) { 2226 SmallVector<Constant*, 16> Elts; 2227 for (unsigned i = 0, e = newMask.size(); i != e; ++i) { 2228 if (newMask[i] < 0) { 2229 Elts.push_back(UndefValue::get(Int32Ty)); 2230 } else { 2231 Elts.push_back(ConstantInt::get(Int32Ty, newMask[i])); 2232 } 2233 } 2234 if (!newRHS) 2235 newRHS = UndefValue::get(newLHS->getType()); 2236 return new ShuffleVectorInst(newLHS, newRHS, ConstantVector::get(Elts)); 2237 } 2238 2239 return MadeChange ? &SVI : nullptr; 2240 } 2241