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