lib/Transforms/LevelRaise.cpp

   1 //===- LevelRaise.cpp - Code to change LLVM to higher level -----------------=//
   2 //
   3 // This file implements the 'raising' part of the LevelChange API.  This is
   4 // useful because, in general, it makes the LLVM code terser and easier to
   5 // analyze.
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #include "llvm/Transforms/LevelChange.h"
  10 #include "llvm/Transforms/Utils/Local.h"
  11 #include "TransformInternals.h"
  12 #include "llvm/iOther.h"
  13 #include "llvm/iMemory.h"
  14 #include "llvm/Pass.h"
  15 #include "llvm/ConstantHandling.h"
  16 #include "llvm/Analysis/Expressions.h"
  17 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  18 #include "Support/STLExtras.h"
  19 #include "Support/StatisticReporter.h"
  20 #include <algorithm>
  21 using std::cerr;
  22
  23 static Statistic<> NumLoadStorePeepholes("raise\t\t- Number of load/store peepholes");
  24 static Statistic<> NumGEPInstFormed("raise\t\t- Number of other getelementptr's formed");
  25 static Statistic<> NumExprTreesConv("raise\t\t- Number of expression trees converted");
  26 static Statistic<> NumCastOfCast("raise\t\t- Number of cast-of-self removed");
  27 static Statistic<> NumDCEorCP("raise\t\t- Number of insts DCE'd or constprop'd");
  28
  29
  30 #define PRINT_PEEPHOLE(ID, NUM, I)            \
  31   DEBUG(std::cerr << "Inst P/H " << ID << "[" << NUM << "] " << I)
  32
  33 #define PRINT_PEEPHOLE1(ID, I1) do { PRINT_PEEPHOLE(ID, 0, I1); } while (0)
  34 #define PRINT_PEEPHOLE2(ID, I1, I2) \
  35   do { PRINT_PEEPHOLE(ID, 0, I1); PRINT_PEEPHOLE(ID, 1, I2); } while (0)
  36 #define PRINT_PEEPHOLE3(ID, I1, I2, I3) \
  37   do { PRINT_PEEPHOLE(ID, 0, I1); PRINT_PEEPHOLE(ID, 1, I2); \
  38        PRINT_PEEPHOLE(ID, 2, I3); } while (0)
  39 #define PRINT_PEEPHOLE4(ID, I1, I2, I3, I4) \
  40   do { PRINT_PEEPHOLE(ID, 0, I1); PRINT_PEEPHOLE(ID, 1, I2); \
  41        PRINT_PEEPHOLE(ID, 2, I3); PRINT_PEEPHOLE(ID, 3, I4); } while (0)
  42
  43
  44 // isReinterpretingCast - Return true if the cast instruction specified will
  45 // cause the operand to be "reinterpreted".  A value is reinterpreted if the
  46 // cast instruction would cause the underlying bits to change.
  47 //
  48 static inline bool isReinterpretingCast(const CastInst *CI) {
  49   return!CI->getOperand(0)->getType()->isLosslesslyConvertableTo(CI->getType());
  50 }
  51
  52
  53 // Peephole optimize the following instructions:
  54 // %t1 = cast ? to x *
  55 // %t2 = add x * %SP, %t1              ;; Constant must be 2nd operand
  56 //
  57 // Into: %t3 = getelementptr {<...>} * %SP, <element indices>
  58 //       %t2 = cast <eltype> * %t3 to {<...>}*
  59 //
  60 static bool HandleCastToPointer(BasicBlock::iterator BI,
  61                                 const PointerType *DestPTy) {
  62   CastInst &CI = cast<CastInst>(*BI);
  63   if (CI.use_empty()) return false;
  64
  65   // Scan all of the uses, looking for any uses that are not add
  66   // instructions.  If we have non-adds, do not make this transformation.
  67   //
  68   for (Value::use_iterator I = CI.use_begin(), E = CI.use_end();
  69        I != E; ++I) {
  70     if (BinaryOperator *BO = dyn_cast<BinaryOperator>(*I)) {
  71       if (BO->getOpcode() != Instruction::Add)
  72         return false;
  73     } else {
  74       return false;
  75     }
  76   }
  77
  78   std::vector<Value*> Indices;
  79   Value *Src = CI.getOperand(0);
  80   const Type *Result = ConvertableToGEP(DestPTy, Src, Indices, &BI);
  81   if (Result == 0) return false;  // Not convertable...
  82
  83   PRINT_PEEPHOLE2("cast-add-to-gep:in", Src, CI);
  84
  85   // If we have a getelementptr capability... transform all of the
  86   // add instruction uses into getelementptr's.
  87   while (!CI.use_empty()) {
  88     BinaryOperator *I = cast<BinaryOperator>(*CI.use_begin());
  89     assert(I->getOpcode() == Instruction::Add && I->getNumOperands() == 2 &&
  90            "Use is not a valid add instruction!");
  91
  92     // Get the value added to the cast result pointer...
  93     Value *OtherPtr = I->getOperand((I->getOperand(0) == &CI) ? 1 : 0);
  94
  95     Instruction *GEP = new GetElementPtrInst(OtherPtr, Indices, I->getName());
  96     PRINT_PEEPHOLE1("cast-add-to-gep:i", I);
  97
  98     if (GEP->getType() == I->getType()) {
  99       // Replace the old add instruction with the shiny new GEP inst
 100       ReplaceInstWithInst(I, GEP);
 101     } else {
 102       // If the type produced by the gep instruction differs from the original
 103       // add instruction type, insert a cast now.
 104       //
 105
 106       // Insert the GEP instruction before the old add instruction...
 107       I->getParent()->getInstList().insert(I, GEP);
 108
 109       PRINT_PEEPHOLE1("cast-add-to-gep:o", GEP);
 110       GEP = new CastInst(GEP, I->getType());
 111
 112       // Replace the old add instruction with the shiny new GEP inst
 113       ReplaceInstWithInst(I, GEP);
 114     }
 115
 116     PRINT_PEEPHOLE1("cast-add-to-gep:o", GEP);
 117   }
 118   return true;
 119 }
 120
 121 // Peephole optimize the following instructions:
 122 // %t1 = cast ulong <const int> to {<...>} *
 123 // %t2 = add {<...>} * %SP, %t1              ;; Constant must be 2nd operand
 124 //
 125 //    or
 126 // %t1 = cast {<...>}* %SP to int*
 127 // %t5 = cast ulong <const int> to int*
 128 // %t2 = add int* %t1, %t5                   ;; int is same size as field
 129 //
 130 // Into: %t3 = getelementptr {<...>} * %SP, <element indices>
 131 //       %t2 = cast <eltype> * %t3 to {<...>}*
 132 //
 133 static bool PeepholeOptimizeAddCast(BasicBlock *BB, BasicBlock::iterator &BI,
 134                                     Value *AddOp1, CastInst *AddOp2) {
 135   const CompositeType *CompTy;
 136   Value *OffsetVal = AddOp2->getOperand(0);
 137   Value *SrcPtr;  // Of type pointer to struct...
 138
 139   if ((CompTy = getPointedToComposite(AddOp1->getType()))) {
 140     SrcPtr = AddOp1;                      // Handle the first case...
 141   } else if (CastInst *AddOp1c = dyn_cast<CastInst>(AddOp1)) {
 142     SrcPtr = AddOp1c->getOperand(0);      // Handle the second case...
 143     CompTy = getPointedToComposite(SrcPtr->getType());
 144   }
 145
 146   // Only proceed if we have detected all of our conditions successfully...
 147   if (!CompTy || !SrcPtr || !OffsetVal->getType()->isIntegral())
 148     return false;
 149
 150   std::vector<Value*> Indices;
 151   if (!ConvertableToGEP(SrcPtr->getType(), OffsetVal, Indices, &BI))
 152     return false;  // Not convertable... perhaps next time
 153
 154   if (getPointedToComposite(AddOp1->getType())) {  // case 1
 155     PRINT_PEEPHOLE2("add-to-gep1:in", AddOp2, *BI);
 156   } else {
 157     PRINT_PEEPHOLE3("add-to-gep2:in", AddOp1, AddOp2, *BI);
 158   }
 159
 160   GetElementPtrInst *GEP = new GetElementPtrInst(SrcPtr, Indices,
 161                                                  AddOp2->getName());
 162   BI = ++BB->getInstList().insert(BI, GEP);
 163
 164   Instruction *NCI = new CastInst(GEP, AddOp1->getType());
 165   ReplaceInstWithInst(BB->getInstList(), BI, NCI);
 166   PRINT_PEEPHOLE2("add-to-gep:out", GEP, NCI);
 167   return true;
 168 }
 169
 170 static bool PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
 171   Instruction *I = BI;
 172
 173   if (CastInst *CI = dyn_cast<CastInst>(I)) {
 174     Value       *Src    = CI->getOperand(0);
 175     Instruction *SrcI   = dyn_cast<Instruction>(Src); // Nonnull if instr source
 176     const Type  *DestTy = CI->getType();
 177
 178     // Peephole optimize the following instruction:
 179     // %V2 = cast <ty> %V to <ty>
 180     //
 181     // Into: <nothing>
 182     //
 183     if (DestTy == Src->getType()) {   // Check for a cast to same type as src!!
 184       PRINT_PEEPHOLE1("cast-of-self-ty", CI);
 185       CI->replaceAllUsesWith(Src);
 186       if (!Src->hasName() && CI->hasName()) {
 187         std::string Name = CI->getName();
 188         CI->setName("");
 189         Src->setName(Name, BB->getParent()->getSymbolTable());
 190       }
 191
 192       // DCE the instruction now, to avoid having the iterative version of DCE
 193       // have to worry about it.
 194       //
 195       BI = BB->getInstList().erase(BI);
 196
 197       ++NumCastOfCast;
 198       return true;
 199     }
 200
 201     // Check to see if it's a cast of an instruction that does not depend on the
 202     // specific type of the operands to do it's job.
 203     if (!isReinterpretingCast(CI)) {
 204       ValueTypeCache ConvertedTypes;
 205
 206       // Check to see if we can convert the source of the cast to match the
 207       // destination type of the cast...
 208       //
 209       ConvertedTypes[CI] = CI->getType();  // Make sure the cast doesn't change
 210       if (ExpressionConvertableToType(Src, DestTy, ConvertedTypes)) {
 211         PRINT_PEEPHOLE3("CAST-SRC-EXPR-CONV:in ", Src, CI, BB->getParent());
 212
 213         DEBUG(cerr << "\nCONVERTING SRC EXPR TYPE:\n");
 214         ValueMapCache ValueMap;
 215         Value *E = ConvertExpressionToType(Src, DestTy, ValueMap);
 216         if (Constant *CPV = dyn_cast<Constant>(E))
 217           CI->replaceAllUsesWith(CPV);
 218
 219         BI = BB->begin();  // Rescan basic block.  BI might be invalidated.
 220         PRINT_PEEPHOLE1("CAST-SRC-EXPR-CONV:out", E);
 221         DEBUG(cerr << "DONE CONVERTING SRC EXPR TYPE: \n" << BB->getParent());
 222         ++NumExprTreesConv;
 223         return true;
 224       }
 225
 226       // Check to see if we can convert the users of the cast value to match the
 227       // source type of the cast...
 228       //
 229       ConvertedTypes.clear();
 230       if (ValueConvertableToType(CI, Src->getType(), ConvertedTypes)) {
 231         PRINT_PEEPHOLE3("CAST-DEST-EXPR-CONV:in ", Src, CI, BB->getParent());
 232
 233         DEBUG(cerr << "\nCONVERTING EXPR TYPE:\n");
 234         ValueMapCache ValueMap;
 235         ConvertValueToNewType(CI, Src, ValueMap);  // This will delete CI!
 236
 237         BI = BB->begin();  // Rescan basic block.  BI might be invalidated.
 238         PRINT_PEEPHOLE1("CAST-DEST-EXPR-CONV:out", Src);
 239         DEBUG(cerr << "DONE CONVERTING EXPR TYPE: \n\n" << BB->getParent());
 240         ++NumExprTreesConv;
 241         return true;
 242       }
 243     }
 244
 245     // Otherwise find out it this cast is a cast to a pointer type, which is
 246     // then added to some other pointer, then loaded or stored through.  If
 247     // so, convert the add into a getelementptr instruction...
 248     //
 249     if (const PointerType *DestPTy = dyn_cast<PointerType>(DestTy)) {
 250       if (HandleCastToPointer(BI, DestPTy)) {
 251         BI = BB->begin();  // Rescan basic block.  BI might be invalidated.
 252         ++NumGEPInstFormed;
 253         return true;
 254       }
 255     }
 256
 257     // Check to see if we are casting from a structure pointer to a pointer to
 258     // the first element of the structure... to avoid munching other peepholes,
 259     // we only let this happen if there are no add uses of the cast.
 260     //
 261     // Peephole optimize the following instructions:
 262     // %t1 = cast {<...>} * %StructPtr to <ty> *
 263     //
 264     // Into: %t2 = getelementptr {<...>} * %StructPtr, <0, 0, 0, ...>
 265     //       %t1 = cast <eltype> * %t1 to <ty> *
 266     //
 267     if (const CompositeType *CTy = getPointedToComposite(Src->getType()))
 268       if (const PointerType *DestPTy = dyn_cast<PointerType>(DestTy)) {
 269
 270         // Loop over uses of the cast, checking for add instructions.  If an add
 271         // exists, this is probably a part of a more complex GEP, so we don't
 272         // want to mess around with the cast.
 273         //
 274         bool HasAddUse = false;
 275         for (Value::use_iterator I = CI->use_begin(), E = CI->use_end();
 276              I != E; ++I)
 277           if (isa<Instruction>(*I) &&
 278               cast<Instruction>(*I)->getOpcode() == Instruction::Add) {
 279             HasAddUse = true; break;
 280           }
 281
 282         // If it doesn't have an add use, check to see if the dest type is
 283         // losslessly convertable to one of the types in the start of the struct
 284         // type.
 285         //
 286         if (!HasAddUse) {
 287           const Type *DestPointedTy = DestPTy->getElementType();
 288           unsigned Depth = 1;
 289           const CompositeType *CurCTy = CTy;
 290           const Type *ElTy = 0;
 291
 292           // Build the index vector, full of all zeros
 293           std::vector<Value*> Indices;
 294           Indices.push_back(ConstantUInt::get(Type::UIntTy, 0));
 295           while (CurCTy && !isa<PointerType>(CurCTy)) {
 296             if (const StructType *CurSTy = dyn_cast<StructType>(CurCTy)) {
 297               // Check for a zero element struct type... if we have one, bail.
 298               if (CurSTy->getElementTypes().size() == 0) break;
 299
 300               // Grab the first element of the struct type, which must lie at
 301               // offset zero in the struct.
 302               //
 303               ElTy = CurSTy->getElementTypes()[0];
 304             } else {
 305               ElTy = cast<ArrayType>(CurCTy)->getElementType();
 306             }
 307
 308             // Insert a zero to index through this type...
 309             Indices.push_back(ConstantUInt::get(CurCTy->getIndexType(), 0));
 310
 311             // Did we find what we're looking for?
 312             if (ElTy->isLosslesslyConvertableTo(DestPointedTy)) break;
 313
 314             // Nope, go a level deeper.
 315             ++Depth;
 316             CurCTy = dyn_cast<CompositeType>(ElTy);
 317             ElTy = 0;
 318           }
 319
 320           // Did we find what we were looking for? If so, do the transformation
 321           if (ElTy) {
 322             PRINT_PEEPHOLE1("cast-for-first:in", CI);
 323
 324             // Insert the new T cast instruction... stealing old T's name
 325             GetElementPtrInst *GEP = new GetElementPtrInst(Src, Indices,
 326                                                            CI->getName());
 327             CI->setName("");
 328             BI = ++BB->getInstList().insert(BI, GEP);
 329
 330             // Make the old cast instruction reference the new GEP instead of
 331             // the old src value.
 332             //
 333             CI->setOperand(0, GEP);
 334
 335             PRINT_PEEPHOLE2("cast-for-first:out", GEP, CI);
 336             ++NumGEPInstFormed;
 337             return true;
 338           }
 339         }
 340       }
 341
 342   } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
 343     Value *Val     = SI->getOperand(0);
 344     Value *Pointer = SI->getPointerOperand();
 345
 346     // Peephole optimize the following instructions:
 347     // %t = cast <T1>* %P to <T2> * ;; If T1 is losslessly convertable to T2
 348     // store <T2> %V, <T2>* %t
 349     //
 350     // Into:
 351     // %t = cast <T2> %V to <T1>
 352     // store <T1> %t2, <T1>* %P
 353     //
 354     // Note: This is not taken care of by expr conversion because there might
 355     // not be a cast available for the store to convert the incoming value of.
 356     // This code is basically here to make sure that pointers don't have casts
 357     // if possible.
 358     //
 359     if (CastInst *CI = dyn_cast<CastInst>(Pointer))
 360       if (Value *CastSrc = CI->getOperand(0)) // CSPT = CastSrcPointerType
 361         if (const PointerType *CSPT = dyn_cast<PointerType>(CastSrc->getType()))
 362           // convertable types?
 363           if (Val->getType()->isLosslesslyConvertableTo(CSPT->getElementType()) &&
 364               !SI->hasIndices()) {      // No subscripts yet!
 365             PRINT_PEEPHOLE3("st-src-cast:in ", Pointer, Val, SI);
 366
 367             // Insert the new T cast instruction... stealing old T's name
 368             CastInst *NCI = new CastInst(Val, CSPT->getElementType(),
 369                                          CI->getName());
 370             CI->setName("");
 371             BI = ++BB->getInstList().insert(BI, NCI);
 372
 373             // Replace the old store with a new one!
 374             ReplaceInstWithInst(BB->getInstList(), BI,
 375                                 SI = new StoreInst(NCI, CastSrc));
 376             PRINT_PEEPHOLE3("st-src-cast:out", NCI, CastSrc, SI);
 377             ++NumLoadStorePeepholes;
 378             return true;
 379           }
 380
 381   } else if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
 382     Value *Pointer = LI->getOperand(0);
 383     const Type *PtrElType =
 384       cast<PointerType>(Pointer->getType())->getElementType();
 385
 386     // Peephole optimize the following instructions:
 387     // %Val = cast <T1>* to <T2>*    ;; If T1 is losslessly convertable to T2
 388     // %t = load <T2>* %P
 389     //
 390     // Into:
 391     // %t = load <T1>* %P
 392     // %Val = cast <T1> to <T2>
 393     //
 394     // Note: This is not taken care of by expr conversion because there might
 395     // not be a cast available for the store to convert the incoming value of.
 396     // This code is basically here to make sure that pointers don't have casts
 397     // if possible.
 398     //
 399     if (CastInst *CI = dyn_cast<CastInst>(Pointer))
 400       if (Value *CastSrc = CI->getOperand(0)) // CSPT = CastSrcPointerType
 401         if (const PointerType *CSPT = dyn_cast<PointerType>(CastSrc->getType()))
 402           // convertable types?
 403           if (PtrElType->isLosslesslyConvertableTo(CSPT->getElementType()) &&
 404               !LI->hasIndices()) {      // No subscripts yet!
 405             PRINT_PEEPHOLE2("load-src-cast:in ", Pointer, LI);
 406
 407             // Create the new load instruction... loading the pre-casted value
 408             LoadInst *NewLI = new LoadInst(CastSrc, LI->getName());
 409
 410             // Insert the new T cast instruction... stealing old T's name
 411             CastInst *NCI = new CastInst(NewLI, LI->getType(), CI->getName());
 412             BI = ++BB->getInstList().insert(BI, NewLI);
 413
 414             // Replace the old store with a new one!
 415             ReplaceInstWithInst(BB->getInstList(), BI, NCI);
 416             PRINT_PEEPHOLE3("load-src-cast:out", NCI, CastSrc, NewLI);
 417             ++NumLoadStorePeepholes;
 418             return true;
 419           }
 420
 421   } else if (I->getOpcode() == Instruction::Add &&
 422              isa<CastInst>(I->getOperand(1))) {
 423
 424     if (PeepholeOptimizeAddCast(BB, BI, I->getOperand(0),
 425                                 cast<CastInst>(I->getOperand(1)))) {
 426       ++NumGEPInstFormed;
 427       return true;
 428     }
 429   }
 430
 431   return false;
 432 }
 433
 434
 435
 436
 437 static bool DoRaisePass(Function &F) {
 438   bool Changed = false;
 439   for (Function::iterator BB = F.begin(), BBE = F.end(); BB != BBE; ++BB)
 440     for (BasicBlock::iterator BI = BB->begin(); BI != BB->end();) {
 441       DEBUG(cerr << "Processing: " << *BI);
 442       if (dceInstruction(BI) || doConstantPropogation(BI)) {
 443         Changed = true;
 444         ++NumDCEorCP;
 445         DEBUG(cerr << "***\t\t^^-- DeadCode Elinated!\n");
 446       } else if (PeepholeOptimize(BB, BI)) {
 447         Changed = true;
 448       } else {
 449         ++BI;
 450       }
 451     }
 452
 453   return Changed;
 454 }
 455
 456
 457 // RaisePointerReferences::doit - Raise a function representation to a higher
 458 // level.
 459 //
 460 static bool doRPR(Function &F) {
 461   DEBUG(cerr << "\n\n\nStarting to work on Function '" << F.getName() << "'\n");
 462
 463   // Insert casts for all incoming pointer pointer values that are treated as
 464   // arrays...
 465   //
 466   bool Changed = false, LocalChange;
 467
 468   do {
 469     DEBUG(cerr << "Looping: \n" << F);
 470
 471     // Iterate over the function, refining it, until it converges on a stable
 472     // state
 473     LocalChange = false;
 474     while (DoRaisePass(F)) LocalChange = true;
 475     Changed |= LocalChange;
 476
 477   } while (LocalChange);
 478
 479   return Changed;
 480 }
 481
 482 namespace {
 483   struct RaisePointerReferences : public FunctionPass {
 484     const char *getPassName() const { return "Raise Pointer References"; }
 485
 486     virtual bool runOnFunction(Function &F) { return doRPR(F); }
 487
 488     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 489       AU.preservesCFG();
 490     }
 491   };
 492 }
 493
 494 Pass *createRaisePointerReferencesPass() {
 495   return new RaisePointerReferences();
 496 }
 497
 498