1 //===- Expressions.cpp - Expression Analysis Utilities ----------------------=//
3 // This file defines a package of expression analysis utilties:
5 // ClassifyExpression: Analyze an expression to determine the complexity of the
6 // expression, and which other variables it depends on.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/Analysis/Expressions.h"
11 #include "llvm/ConstantHandling.h"
12 #include "llvm/Function.h"
13 #include "llvm/BasicBlock.h"
14 #include "llvm/Instruction.h"
17 using namespace analysis;
19 ExprType::ExprType(Value *Val) {
21 if (ConstantInt *CPI = dyn_cast<ConstantInt>(Val)) {
29 Var = Val; Offset = 0;
30 ExprTy = Var ? Linear : Constant;
34 ExprType::ExprType(const ConstantInt *scale, Value *var,
35 const ConstantInt *offset) {
36 Scale = var ? scale : 0; Var = var; Offset = offset;
37 ExprTy = Scale ? ScaledLinear : (Var ? Linear : Constant);
38 if (Scale && Scale->equalsInt(0)) { // Simplify 0*Var + const
45 const Type *ExprType::getExprType(const Type *Default) const {
46 if (Offset) return Offset->getType();
47 if (Scale) return Scale->getType();
48 return Var ? Var->getType() : Default;
54 const ConstantInt * const Val;
55 const Type * const Ty;
57 inline DefVal(const ConstantInt *val, const Type *ty) : Val(val), Ty(ty) {}
59 inline const Type *getType() const { return Ty; }
60 inline const ConstantInt *getVal() const { return Val; }
61 inline operator const ConstantInt * () const { return Val; }
62 inline const ConstantInt *operator->() const { return Val; }
65 struct DefZero : public DefVal {
66 inline DefZero(const ConstantInt *val, const Type *ty) : DefVal(val, ty) {}
67 inline DefZero(const ConstantInt *val) : DefVal(val, val->getType()) {}
70 struct DefOne : public DefVal {
71 inline DefOne(const ConstantInt *val, const Type *ty) : DefVal(val, ty) {}
75 // getUnsignedConstant - Return a constant value of the specified type. If the
76 // constant value is not valid for the specified type, return null. This cannot
77 // happen for values in the range of 0 to 127.
79 static ConstantInt *getUnsignedConstant(uint64_t V, const Type *Ty) {
80 if (isa<PointerType>(Ty)) Ty = Type::ULongTy;
82 // If this value is not a valid unsigned value for this type, return null!
83 if (V > 127 && ((int64_t)V < 0 ||
84 !ConstantSInt::isValueValidForType(Ty, (int64_t)V)))
86 return ConstantSInt::get(Ty, V);
88 // If this value is not a valid unsigned value for this type, return null!
89 if (V > 255 && !ConstantUInt::isValueValidForType(Ty, V))
91 return ConstantUInt::get(Ty, V);
95 // Add - Helper function to make later code simpler. Basically it just adds
96 // the two constants together, inserts the result into the constant pool, and
97 // returns it. Of course life is not simple, and this is no exception. Factors
98 // that complicate matters:
99 // 1. Either argument may be null. If this is the case, the null argument is
100 // treated as either 0 (if DefOne = false) or 1 (if DefOne = true)
101 // 2. Types get in the way. We want to do arithmetic operations without
102 // regard for the underlying types. It is assumed that the constants are
103 // integral constants. The new value takes the type of the left argument.
104 // 3. If DefOne is true, a null return value indicates a value of 1, if DefOne
105 // is false, a null return value indicates a value of 0.
107 static const ConstantInt *Add(const ConstantInt *Arg1,
108 const ConstantInt *Arg2, bool DefOne) {
109 assert(Arg1 && Arg2 && "No null arguments should exist now!");
110 assert(Arg1->getType() == Arg2->getType() && "Types must be compatible!");
112 // Actually perform the computation now!
113 Constant *Result = *Arg1 + *Arg2;
114 assert(Result && Result->getType() == Arg1->getType() &&
115 "Couldn't perform addition!");
116 ConstantInt *ResultI = cast<ConstantInt>(Result);
118 // Check to see if the result is one of the special cases that we want to
120 if (ResultI->equalsInt(DefOne ? 1 : 0))
121 return 0; // Yes it is, simply return null.
126 inline const ConstantInt *operator+(const DefZero &L, const DefZero &R) {
127 if (L == 0) return R;
128 if (R == 0) return L;
129 return Add(L, R, false);
132 inline const ConstantInt *operator+(const DefOne &L, const DefOne &R) {
135 return getUnsignedConstant(2, L.getType());
137 return Add(getUnsignedConstant(1, L.getType()), R, true);
139 return Add(L, getUnsignedConstant(1, L.getType()), true);
141 return Add(L, R, true);
145 // Mul - Helper function to make later code simpler. Basically it just
146 // multiplies the two constants together, inserts the result into the constant
147 // pool, and returns it. Of course life is not simple, and this is no
148 // exception. Factors that complicate matters:
149 // 1. Either argument may be null. If this is the case, the null argument is
150 // treated as either 0 (if DefOne = false) or 1 (if DefOne = true)
151 // 2. Types get in the way. We want to do arithmetic operations without
152 // regard for the underlying types. It is assumed that the constants are
153 // integral constants.
154 // 3. If DefOne is true, a null return value indicates a value of 1, if DefOne
155 // is false, a null return value indicates a value of 0.
157 inline const ConstantInt *Mul(const ConstantInt *Arg1,
158 const ConstantInt *Arg2, bool DefOne) {
159 assert(Arg1 && Arg2 && "No null arguments should exist now!");
160 assert(Arg1->getType() == Arg2->getType() && "Types must be compatible!");
162 // Actually perform the computation now!
163 Constant *Result = *Arg1 * *Arg2;
164 assert(Result && Result->getType() == Arg1->getType() &&
165 "Couldn't perform multiplication!");
166 ConstantInt *ResultI = cast<ConstantInt>(Result);
168 // Check to see if the result is one of the special cases that we want to
170 if (ResultI->equalsInt(DefOne ? 1 : 0))
171 return 0; // Yes it is, simply return null.
176 inline const ConstantInt *operator*(const DefZero &L, const DefZero &R) {
177 if (L == 0 || R == 0) return 0;
178 return Mul(L, R, false);
180 inline const ConstantInt *operator*(const DefOne &L, const DefZero &R) {
181 if (R == 0) return getUnsignedConstant(0, L.getType());
182 if (L == 0) return R->equalsInt(1) ? 0 : R.getVal();
183 return Mul(L, R, true);
185 inline const ConstantInt *operator*(const DefZero &L, const DefOne &R) {
186 if (L == 0 || R == 0) return L.getVal();
187 return Mul(R, L, false);
190 // handleAddition - Add two expressions together, creating a new expression that
191 // represents the composite of the two...
193 static ExprType handleAddition(ExprType Left, ExprType Right, Value *V) {
194 const Type *Ty = V->getType();
195 if (Left.ExprTy > Right.ExprTy)
196 std::swap(Left, Right); // Make left be simpler than right
198 switch (Left.ExprTy) {
199 case ExprType::Constant:
200 return ExprType(Right.Scale, Right.Var,
201 DefZero(Right.Offset, Ty) + DefZero(Left.Offset, Ty));
202 case ExprType::Linear: // RHS side must be linear or scaled
203 case ExprType::ScaledLinear: // RHS must be scaled
204 if (Left.Var != Right.Var) // Are they the same variables?
205 return V; // if not, we don't know anything!
207 return ExprType(DefOne(Left.Scale , Ty) + DefOne(Right.Scale , Ty),
209 DefZero(Left.Offset, Ty) + DefZero(Right.Offset, Ty));
211 assert(0 && "Dont' know how to handle this case!");
216 // negate - Negate the value of the specified expression...
218 static inline ExprType negate(const ExprType &E, Value *V) {
219 const Type *Ty = V->getType();
220 ConstantInt *Zero = getUnsignedConstant(0, Ty);
221 ConstantInt *One = getUnsignedConstant(1, Ty);
222 ConstantInt *NegOne = cast<ConstantInt>(*Zero - *One);
223 if (NegOne == 0) return V; // Couldn't subtract values...
225 return ExprType(DefOne (E.Scale , Ty) * NegOne, E.Var,
226 DefZero(E.Offset, Ty) * NegOne);
230 // ClassifyExpression: Analyze an expression to determine the complexity of the
231 // expression, and which other values it depends on.
233 // Note that this analysis cannot get into infinite loops because it treats PHI
234 // nodes as being an unknown linear expression.
236 ExprType analysis::ClassifyExpression(Value *Expr) {
237 assert(Expr != 0 && "Can't classify a null expression!");
238 if (Expr->getType() == Type::FloatTy || Expr->getType() == Type::DoubleTy)
239 return Expr; // FIXME: Can't handle FP expressions
241 switch (Expr->getValueType()) {
242 case Value::InstructionVal: break; // Instruction... hmmm... investigate.
243 case Value::TypeVal: case Value::BasicBlockVal:
244 case Value::FunctionVal: default:
245 //assert(0 && "Unexpected expression type to classify!");
246 std::cerr << "Bizarre thing to expr classify: " << Expr << "\n";
248 case Value::GlobalVariableVal: // Global Variable & Function argument:
249 case Value::ArgumentVal: // nothing known, return variable itself
251 case Value::ConstantVal: // Constant value, just return constant
252 Constant *CPV = cast<Constant>(Expr);
253 if (CPV->getType()->isIntegral()) { // It's an integral constant!
254 ConstantInt *CPI = cast<ConstantInt>(Expr);
255 return ExprType(CPI->equalsInt(0) ? 0 : CPI);
260 Instruction *I = cast<Instruction>(Expr);
261 const Type *Ty = I->getType();
263 switch (I->getOpcode()) { // Handle each instruction type seperately
264 case Instruction::Add: {
265 ExprType Left (ClassifyExpression(I->getOperand(0)));
266 ExprType Right(ClassifyExpression(I->getOperand(1)));
267 return handleAddition(Left, Right, I);
268 } // end case Instruction::Add
270 case Instruction::Sub: {
271 ExprType Left (ClassifyExpression(I->getOperand(0)));
272 ExprType Right(ClassifyExpression(I->getOperand(1)));
273 ExprType RightNeg = negate(Right, I);
274 if (RightNeg.Var == I && !RightNeg.Offset && !RightNeg.Scale)
275 return I; // Could not negate value...
276 return handleAddition(Left, RightNeg, I);
277 } // end case Instruction::Sub
279 case Instruction::Shl: {
280 ExprType Right(ClassifyExpression(I->getOperand(1)));
281 if (Right.ExprTy != ExprType::Constant) break;
282 ExprType Left(ClassifyExpression(I->getOperand(0)));
283 if (Right.Offset == 0) return Left; // shl x, 0 = x
284 assert(Right.Offset->getType() == Type::UByteTy &&
285 "Shift amount must always be a unsigned byte!");
286 uint64_t ShiftAmount = ((ConstantUInt*)Right.Offset)->getValue();
287 ConstantInt *Multiplier = getUnsignedConstant(1ULL << ShiftAmount, Ty);
289 // We don't know how to classify it if they are shifting by more than what
290 // is reasonable. In most cases, the result will be zero, but there is one
291 // class of cases where it is not, so we cannot optimize without checking
292 // for it. The case is when you are shifting a signed value by 1 less than
293 // the number of bits in the value. For example:
294 // %X = shl sbyte %Y, ubyte 7
295 // will try to form an sbyte multiplier of 128, which will give a null
296 // multiplier, even though the result is not 0. Until we can check for this
297 // case, be conservative. TODO.
302 return ExprType(DefOne(Left.Scale, Ty) * Multiplier, Left.Var,
303 DefZero(Left.Offset, Ty) * Multiplier);
304 } // end case Instruction::Shl
306 case Instruction::Mul: {
307 ExprType Left (ClassifyExpression(I->getOperand(0)));
308 ExprType Right(ClassifyExpression(I->getOperand(1)));
309 if (Left.ExprTy > Right.ExprTy)
310 std::swap(Left, Right); // Make left be simpler than right
312 if (Left.ExprTy != ExprType::Constant) // RHS must be > constant
313 return I; // Quadratic eqn! :(
315 const ConstantInt *Offs = Left.Offset;
316 if (Offs == 0) return ExprType();
317 return ExprType( DefOne(Right.Scale , Ty) * Offs, Right.Var,
318 DefZero(Right.Offset, Ty) * Offs);
319 } // end case Instruction::Mul
321 case Instruction::Cast: {
322 ExprType Src(ClassifyExpression(I->getOperand(0)));
323 const Type *DestTy = I->getType();
324 if (isa<PointerType>(DestTy))
325 DestTy = Type::ULongTy; // Pointer types are represented as ulong
328 if (!Src.getExprType(0)->isLosslesslyConvertableTo(DestTy)) {
329 if (Src.ExprTy != ExprType::Constant)
330 return I; // Converting cast, and not a constant value...
334 const ConstantInt *Offset = Src.Offset;
335 const ConstantInt *Scale = Src.Scale;
337 const Constant *CPV = ConstantFoldCastInstruction(Offset, DestTy);
339 Offset = cast<ConstantInt>(CPV);
342 const Constant *CPV = ConstantFoldCastInstruction(Scale, DestTy);
344 Scale = cast<ConstantInt>(CPV);
346 return ExprType(Scale, Src.Var, Offset);
347 } // end case Instruction::Cast
348 // TODO: Handle SUB, SHR?
352 // Otherwise, I don't know anything about this value!