lib/Analysis/Expressions.cpp

   1 //===- Expressions.cpp - Expression Analysis Utilities --------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines a package of expression analysis utilties:
  11 //
  12 // ClassifyExpression: Analyze an expression to determine the complexity of the
  13 //   expression, and which other variables it depends on.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/Analysis/Expressions.h"
  18 #include "llvm/ConstantHandling.h"
  19 #include "llvm/Function.h"
  20
  21 namespace llvm {
  22
  23 ExprType::ExprType(Value *Val) {
  24   if (Val)
  25     if (ConstantInt *CPI = dyn_cast<ConstantInt>(Val)) {
  26       Offset = CPI;
  27       Var = 0;
  28       ExprTy = Constant;
  29       Scale = 0;
  30       return;
  31     }
  32
  33   Var = Val; Offset = 0;
  34   ExprTy = Var ? Linear : Constant;
  35   Scale = 0;
  36 }
  37
  38 ExprType::ExprType(const ConstantInt *scale, Value *var,
  39                    const ConstantInt *offset) {
  40   Scale = var ? scale : 0; Var = var; Offset = offset;
  41   ExprTy = Scale ? ScaledLinear : (Var ? Linear : Constant);
  42   if (Scale && Scale->isNullValue()) {  // Simplify 0*Var + const
  43     Scale = 0; Var = 0;
  44     ExprTy = Constant;
  45   }
  46 }
  47
  48
  49 const Type *ExprType::getExprType(const Type *Default) const {
  50   if (Offset) return Offset->getType();
  51   if (Scale) return Scale->getType();
  52   return Var ? Var->getType() : Default;
  53 }
  54
  55
  56
  57 class DefVal {
  58   const ConstantInt * const Val;
  59   const Type * const Ty;
  60 protected:
  61   inline DefVal(const ConstantInt *val, const Type *ty) : Val(val), Ty(ty) {}
  62 public:
  63   inline const Type *getType() const { return Ty; }
  64   inline const ConstantInt *getVal() const { return Val; }
  65   inline operator const ConstantInt * () const { return Val; }
  66   inline const ConstantInt *operator->() const { return Val; }
  67 };
  68
  69 struct DefZero : public DefVal {
  70   inline DefZero(const ConstantInt *val, const Type *ty) : DefVal(val, ty) {}
  71   inline DefZero(const ConstantInt *val) : DefVal(val, val->getType()) {}
  72 };
  73
  74 struct DefOne : public DefVal {
  75   inline DefOne(const ConstantInt *val, const Type *ty) : DefVal(val, ty) {}
  76 };
  77
  78
  79 // getUnsignedConstant - Return a constant value of the specified type.  If the
  80 // constant value is not valid for the specified type, return null.  This cannot
  81 // happen for values in the range of 0 to 127.
  82 //
  83 static ConstantInt *getUnsignedConstant(uint64_t V, const Type *Ty) {
  84   if (isa<PointerType>(Ty)) Ty = Type::ULongTy;
  85   if (Ty->isSigned()) {
  86     // If this value is not a valid unsigned value for this type, return null!
  87     if (V > 127 && ((int64_t)V < 0 ||
  88                     !ConstantSInt::isValueValidForType(Ty, (int64_t)V)))
  89       return 0;
  90     return ConstantSInt::get(Ty, V);
  91   } else {
  92     // If this value is not a valid unsigned value for this type, return null!
  93     if (V > 255 && !ConstantUInt::isValueValidForType(Ty, V))
  94       return 0;
  95     return ConstantUInt::get(Ty, V);
  96   }
  97 }
  98
  99 // Add - Helper function to make later code simpler.  Basically it just adds
 100 // the two constants together, inserts the result into the constant pool, and
 101 // returns it.  Of course life is not simple, and this is no exception.  Factors
 102 // that complicate matters:
 103 //   1. Either argument may be null.  If this is the case, the null argument is
 104 //      treated as either 0 (if DefOne = false) or 1 (if DefOne = true)
 105 //   2. Types get in the way.  We want to do arithmetic operations without
 106 //      regard for the underlying types.  It is assumed that the constants are
 107 //      integral constants.  The new value takes the type of the left argument.
 108 //   3. If DefOne is true, a null return value indicates a value of 1, if DefOne
 109 //      is false, a null return value indicates a value of 0.
 110 //
 111 static const ConstantInt *Add(const ConstantInt *Arg1,
 112                               const ConstantInt *Arg2, bool DefOne) {
 113   assert(Arg1 && Arg2 && "No null arguments should exist now!");
 114   assert(Arg1->getType() == Arg2->getType() && "Types must be compatible!");
 115
 116   // Actually perform the computation now!
 117   Constant *Result = *Arg1 + *Arg2;
 118   assert(Result && Result->getType() == Arg1->getType() &&
 119          "Couldn't perform addition!");
 120   ConstantInt *ResultI = cast<ConstantInt>(Result);
 121
 122   // Check to see if the result is one of the special cases that we want to
 123   // recognize...
 124   if (ResultI->equalsInt(DefOne ? 1 : 0))
 125     return 0;  // Yes it is, simply return null.
 126
 127   return ResultI;
 128 }
 129
 130 inline const ConstantInt *operator+(const DefZero &L, const DefZero &R) {
 131   if (L == 0) return R;
 132   if (R == 0) return L;
 133   return Add(L, R, false);
 134 }
 135
 136 inline const ConstantInt *operator+(const DefOne &L, const DefOne &R) {
 137   if (L == 0) {
 138     if (R == 0)
 139       return getUnsignedConstant(2, L.getType());
 140     else
 141       return Add(getUnsignedConstant(1, L.getType()), R, true);
 142   } else if (R == 0) {
 143     return Add(L, getUnsignedConstant(1, L.getType()), true);
 144   }
 145   return Add(L, R, true);
 146 }
 147
 148
 149 // Mul - Helper function to make later code simpler.  Basically it just
 150 // multiplies the two constants together, inserts the result into the constant
 151 // pool, and returns it.  Of course life is not simple, and this is no
 152 // exception.  Factors that complicate matters:
 153 //   1. Either argument may be null.  If this is the case, the null argument is
 154 //      treated as either 0 (if DefOne = false) or 1 (if DefOne = true)
 155 //   2. Types get in the way.  We want to do arithmetic operations without
 156 //      regard for the underlying types.  It is assumed that the constants are
 157 //      integral constants.
 158 //   3. If DefOne is true, a null return value indicates a value of 1, if DefOne
 159 //      is false, a null return value indicates a value of 0.
 160 //
 161 inline const ConstantInt *Mul(const ConstantInt *Arg1,
 162                               const ConstantInt *Arg2, bool DefOne) {
 163   assert(Arg1 && Arg2 && "No null arguments should exist now!");
 164   assert(Arg1->getType() == Arg2->getType() && "Types must be compatible!");
 165
 166   // Actually perform the computation now!
 167   Constant *Result = *Arg1 * *Arg2;
 168   assert(Result && Result->getType() == Arg1->getType() &&
 169          "Couldn't perform multiplication!");
 170   ConstantInt *ResultI = cast<ConstantInt>(Result);
 171
 172   // Check to see if the result is one of the special cases that we want to
 173   // recognize...
 174   if (ResultI->equalsInt(DefOne ? 1 : 0))
 175     return 0; // Yes it is, simply return null.
 176
 177   return ResultI;
 178 }
 179
 180 inline const ConstantInt *operator*(const DefZero &L, const DefZero &R) {
 181   if (L == 0 || R == 0) return 0;
 182   return Mul(L, R, false);
 183 }
 184 inline const ConstantInt *operator*(const DefOne &L, const DefZero &R) {
 185   if (R == 0) return getUnsignedConstant(0, L.getType());
 186   if (L == 0) return R->equalsInt(1) ? 0 : R.getVal();
 187   return Mul(L, R, true);
 188 }
 189 inline const ConstantInt *operator*(const DefZero &L, const DefOne &R) {
 190   if (L == 0 || R == 0) return L.getVal();
 191   return Mul(R, L, false);
 192 }
 193
 194 // handleAddition - Add two expressions together, creating a new expression that
 195 // represents the composite of the two...
 196 //
 197 static ExprType handleAddition(ExprType Left, ExprType Right, Value *V) {
 198   const Type *Ty = V->getType();
 199   if (Left.ExprTy > Right.ExprTy)
 200     std::swap(Left, Right);   // Make left be simpler than right
 201
 202   switch (Left.ExprTy) {
 203   case ExprType::Constant:
 204         return ExprType(Right.Scale, Right.Var,
 205                         DefZero(Right.Offset, Ty) + DefZero(Left.Offset, Ty));
 206   case ExprType::Linear:              // RHS side must be linear or scaled
 207   case ExprType::ScaledLinear:        // RHS must be scaled
 208     if (Left.Var != Right.Var)        // Are they the same variables?
 209       return V;                       //   if not, we don't know anything!
 210
 211     return ExprType(DefOne(Left.Scale  , Ty) + DefOne(Right.Scale , Ty),
 212                     Right.Var,
 213                     DefZero(Left.Offset, Ty) + DefZero(Right.Offset, Ty));
 214   default:
 215     assert(0 && "Dont' know how to handle this case!");
 216     return ExprType();
 217   }
 218 }
 219
 220 // negate - Negate the value of the specified expression...
 221 //
 222 static inline ExprType negate(const ExprType &E, Value *V) {
 223   const Type *Ty = V->getType();
 224   ConstantInt *Zero   = getUnsignedConstant(0, Ty);
 225   ConstantInt *One    = getUnsignedConstant(1, Ty);
 226   ConstantInt *NegOne = cast<ConstantInt>(*Zero - *One);
 227   if (NegOne == 0) return V;  // Couldn't subtract values...
 228
 229   return ExprType(DefOne (E.Scale , Ty) * NegOne, E.Var,
 230                   DefZero(E.Offset, Ty) * NegOne);
 231 }
 232
 233
 234 // ClassifyExpression: Analyze an expression to determine the complexity of the
 235 // expression, and which other values it depends on.
 236 //
 237 // Note that this analysis cannot get into infinite loops because it treats PHI
 238 // nodes as being an unknown linear expression.
 239 //
 240 ExprType ClassifyExpression(Value *Expr) {
 241   assert(Expr != 0 && "Can't classify a null expression!");
 242   if (Expr->getType() == Type::FloatTy || Expr->getType() == Type::DoubleTy)
 243     return Expr;   // FIXME: Can't handle FP expressions
 244
 245   switch (Expr->getValueType()) {
 246   case Value::InstructionVal: break;    // Instruction... hmmm... investigate.
 247   case Value::TypeVal:   case Value::BasicBlockVal:
 248   case Value::FunctionVal: default:
 249     //assert(0 && "Unexpected expression type to classify!");
 250     std::cerr << "Bizarre thing to expr classify: " << Expr << "\n";
 251     return Expr;
 252   case Value::GlobalVariableVal:        // Global Variable & Function argument:
 253   case Value::ArgumentVal:              // nothing known, return variable itself
 254     return Expr;
 255   case Value::ConstantVal:              // Constant value, just return constant
 256     if (ConstantInt *CPI = dyn_cast<ConstantInt>(cast<Constant>(Expr)))
 257       // It's an integral constant!
 258       return ExprType(CPI->isNullValue() ? 0 : CPI);
 259     return Expr;
 260   }
 261
 262   Instruction *I = cast<Instruction>(Expr);
 263   const Type *Ty = I->getType();
 264
 265   switch (I->getOpcode()) {       // Handle each instruction type separately
 266   case Instruction::Add: {
 267     ExprType Left (ClassifyExpression(I->getOperand(0)));
 268     ExprType Right(ClassifyExpression(I->getOperand(1)));
 269     return handleAddition(Left, Right, I);
 270   }  // end case Instruction::Add
 271
 272   case Instruction::Sub: {
 273     ExprType Left (ClassifyExpression(I->getOperand(0)));
 274     ExprType Right(ClassifyExpression(I->getOperand(1)));
 275     ExprType RightNeg = negate(Right, I);
 276     if (RightNeg.Var == I && !RightNeg.Offset && !RightNeg.Scale)
 277       return I;   // Could not negate value...
 278     return handleAddition(Left, RightNeg, I);
 279   }  // end case Instruction::Sub
 280
 281   case Instruction::Shl: {
 282     ExprType Right(ClassifyExpression(I->getOperand(1)));
 283     if (Right.ExprTy != ExprType::Constant) break;
 284     ExprType Left(ClassifyExpression(I->getOperand(0)));
 285     if (Right.Offset == 0) return Left;   // shl x, 0 = x
 286     assert(Right.Offset->getType() == Type::UByteTy &&
 287            "Shift amount must always be a unsigned byte!");
 288     uint64_t ShiftAmount = cast<ConstantUInt>(Right.Offset)->getValue();
 289     ConstantInt *Multiplier = getUnsignedConstant(1ULL << ShiftAmount, Ty);
 290
 291     // We don't know how to classify it if they are shifting by more than what
 292     // is reasonable.  In most cases, the result will be zero, but there is one
 293     // class of cases where it is not, so we cannot optimize without checking
 294     // for it.  The case is when you are shifting a signed value by 1 less than
 295     // the number of bits in the value.  For example:
 296     //    %X = shl sbyte %Y, ubyte 7
 297     // will try to form an sbyte multiplier of 128, which will give a null
 298     // multiplier, even though the result is not 0.  Until we can check for this
 299     // case, be conservative.  TODO.
 300     //
 301     if (Multiplier == 0)
 302       return Expr;
 303
 304     return ExprType(DefOne(Left.Scale, Ty) * Multiplier, Left.Var,
 305                     DefZero(Left.Offset, Ty) * Multiplier);
 306   }  // end case Instruction::Shl
 307
 308   case Instruction::Mul: {
 309     ExprType Left (ClassifyExpression(I->getOperand(0)));
 310     ExprType Right(ClassifyExpression(I->getOperand(1)));
 311     if (Left.ExprTy > Right.ExprTy)
 312       std::swap(Left, Right);   // Make left be simpler than right
 313
 314     if (Left.ExprTy != ExprType::Constant)  // RHS must be > constant
 315       return I;         // Quadratic eqn! :(
 316
 317     const ConstantInt *Offs = Left.Offset;
 318     if (Offs == 0) return ExprType();
 319     return ExprType( DefOne(Right.Scale , Ty) * Offs, Right.Var,
 320                     DefZero(Right.Offset, Ty) * Offs);
 321   } // end case Instruction::Mul
 322
 323   case Instruction::Cast: {
 324     ExprType Src(ClassifyExpression(I->getOperand(0)));
 325     const Type *DestTy = I->getType();
 326     if (isa<PointerType>(DestTy))
 327       DestTy = Type::ULongTy;  // Pointer types are represented as ulong
 328
 329     const Type *SrcValTy = Src.getExprType(0);
 330     if (!SrcValTy) return I;
 331     if (!SrcValTy->isLosslesslyConvertibleTo(DestTy)) {
 332       if (Src.ExprTy != ExprType::Constant)
 333         return I;  // Converting cast, and not a constant value...
 334     }
 335
 336     const ConstantInt *Offset = Src.Offset;
 337     const ConstantInt *Scale  = Src.Scale;
 338     if (Offset) {
 339       const Constant *CPV = ConstantFoldCastInstruction(Offset, DestTy);
 340       if (!CPV) return I;
 341       Offset = cast<ConstantInt>(CPV);
 342     }
 343     if (Scale) {
 344       const Constant *CPV = ConstantFoldCastInstruction(Scale, DestTy);
 345       if (!CPV) return I;
 346       Scale = cast<ConstantInt>(CPV);
 347     }
 348     return ExprType(Scale, Src.Var, Offset);
 349   } // end case Instruction::Cast
 350     // TODO: Handle SUB, SHR?
 351
 352   }  // end switch
 353
 354   // Otherwise, I don't know anything about this value!
 355   return I;
 356 }
 357
 358 } // End llvm namespace