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