blob: 12010646bced3fb5109b9b9fb6ebcc3c2de77cff [file] [log] [blame]
Chris Lattnera42f09a2008-07-11 19:10:17 +00001//===--- ExprConstant.cpp - Expression Constant Evaluator -----------------===//
Anders Carlssonc7436af2008-07-03 04:20:39 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the Expr constant evaluator.
11//
12//===----------------------------------------------------------------------===//
13
14#include "clang/AST/APValue.h"
15#include "clang/AST/ASTContext.h"
Seo Sanghyeonefddb9c2008-07-08 07:23:12 +000016#include "clang/AST/StmtVisitor.h"
Chris Lattner82437da2008-07-12 00:14:42 +000017#include "clang/Basic/Diagnostic.h"
Anders Carlssonc0328012008-07-08 05:49:43 +000018#include "clang/Basic/TargetInfo.h"
Anders Carlssoncad17b52008-07-08 05:13:58 +000019#include "llvm/Support/Compiler.h"
Anders Carlssonc7436af2008-07-03 04:20:39 +000020using namespace clang;
Chris Lattnera823ccf2008-07-11 18:11:29 +000021using llvm::APSInt;
Eli Friedman2f445492008-08-22 00:06:13 +000022using llvm::APFloat;
Anders Carlssonc7436af2008-07-03 04:20:39 +000023
Chris Lattner422373c2008-07-11 22:52:41 +000024/// EvalInfo - This is a private struct used by the evaluator to capture
25/// information about a subexpression as it is folded. It retains information
26/// about the AST context, but also maintains information about the folded
27/// expression.
28///
29/// If an expression could be evaluated, it is still possible it is not a C
30/// "integer constant expression" or constant expression. If not, this struct
31/// captures information about how and why not.
32///
33/// One bit of information passed *into* the request for constant folding
34/// indicates whether the subexpression is "evaluated" or not according to C
35/// rules. For example, the RHS of (0 && foo()) is not evaluated. We can
36/// evaluate the expression regardless of what the RHS is, but C only allows
37/// certain things in certain situations.
38struct EvalInfo {
39 ASTContext &Ctx;
40
41 /// isEvaluated - True if the subexpression is required to be evaluated, false
42 /// if it is short-circuited (according to C rules).
43 bool isEvaluated;
44
Chris Lattner82437da2008-07-12 00:14:42 +000045 /// ICEDiag - If the expression is unfoldable, then ICEDiag contains the
46 /// error diagnostic indicating why it is not foldable and DiagLoc indicates a
47 /// caret position for the error. If it is foldable, but the expression is
48 /// not an integer constant expression, ICEDiag contains the extension
49 /// diagnostic to emit which describes why it isn't an integer constant
50 /// expression. If this expression *is* an integer-constant-expr, then
51 /// ICEDiag is zero.
Chris Lattner422373c2008-07-11 22:52:41 +000052 ///
Chris Lattner82437da2008-07-12 00:14:42 +000053 /// The caller can choose to emit this diagnostic or not, depending on whether
54 /// they require an i-c-e or a constant or not. DiagLoc indicates the caret
55 /// position for the report.
56 ///
57 /// If ICEDiag is zero, then this expression is an i-c-e.
Chris Lattner422373c2008-07-11 22:52:41 +000058 unsigned ICEDiag;
59 SourceLocation DiagLoc;
60
61 EvalInfo(ASTContext &ctx) : Ctx(ctx), isEvaluated(true), ICEDiag(0) {}
62};
63
64
65static bool EvaluatePointer(const Expr *E, APValue &Result, EvalInfo &Info);
66static bool EvaluateInteger(const Expr *E, APSInt &Result, EvalInfo &Info);
Eli Friedman2f445492008-08-22 00:06:13 +000067static bool EvaluateFloat(const Expr *E, APFloat &Result, EvalInfo &Info);
Chris Lattnera823ccf2008-07-11 18:11:29 +000068
69//===----------------------------------------------------------------------===//
70// Pointer Evaluation
71//===----------------------------------------------------------------------===//
72
Anders Carlssoncad17b52008-07-08 05:13:58 +000073namespace {
Anders Carlsson02a34c32008-07-08 14:30:00 +000074class VISIBILITY_HIDDEN PointerExprEvaluator
75 : public StmtVisitor<PointerExprEvaluator, APValue> {
Chris Lattner422373c2008-07-11 22:52:41 +000076 EvalInfo &Info;
Anders Carlsson02a34c32008-07-08 14:30:00 +000077public:
Anders Carlsson02a34c32008-07-08 14:30:00 +000078
Chris Lattner422373c2008-07-11 22:52:41 +000079 PointerExprEvaluator(EvalInfo &info) : Info(info) {}
Chris Lattnera823ccf2008-07-11 18:11:29 +000080
Anders Carlsson02a34c32008-07-08 14:30:00 +000081 APValue VisitStmt(Stmt *S) {
Anders Carlsson02a34c32008-07-08 14:30:00 +000082 return APValue();
83 }
84
85 APValue VisitParenExpr(ParenExpr *E) { return Visit(E->getSubExpr()); }
86
Anders Carlssonc43f44b2008-07-08 15:34:11 +000087 APValue VisitBinaryOperator(const BinaryOperator *E);
88 APValue VisitCastExpr(const CastExpr* E);
Anders Carlssonc43f44b2008-07-08 15:34:11 +000089};
Chris Lattnera823ccf2008-07-11 18:11:29 +000090} // end anonymous namespace
Anders Carlssonc43f44b2008-07-08 15:34:11 +000091
Chris Lattner422373c2008-07-11 22:52:41 +000092static bool EvaluatePointer(const Expr* E, APValue& Result, EvalInfo &Info) {
Chris Lattnera823ccf2008-07-11 18:11:29 +000093 if (!E->getType()->isPointerType())
94 return false;
Chris Lattner422373c2008-07-11 22:52:41 +000095 Result = PointerExprEvaluator(Info).Visit(const_cast<Expr*>(E));
Chris Lattnera823ccf2008-07-11 18:11:29 +000096 return Result.isLValue();
97}
98
99APValue PointerExprEvaluator::VisitBinaryOperator(const BinaryOperator *E) {
100 if (E->getOpcode() != BinaryOperator::Add &&
101 E->getOpcode() != BinaryOperator::Sub)
102 return APValue();
103
104 const Expr *PExp = E->getLHS();
105 const Expr *IExp = E->getRHS();
106 if (IExp->getType()->isPointerType())
107 std::swap(PExp, IExp);
108
109 APValue ResultLValue;
Chris Lattner422373c2008-07-11 22:52:41 +0000110 if (!EvaluatePointer(PExp, ResultLValue, Info))
Chris Lattnera823ccf2008-07-11 18:11:29 +0000111 return APValue();
112
113 llvm::APSInt AdditionalOffset(32);
Chris Lattner422373c2008-07-11 22:52:41 +0000114 if (!EvaluateInteger(IExp, AdditionalOffset, Info))
Chris Lattnera823ccf2008-07-11 18:11:29 +0000115 return APValue();
116
117 uint64_t Offset = ResultLValue.getLValueOffset();
118 if (E->getOpcode() == BinaryOperator::Add)
119 Offset += AdditionalOffset.getZExtValue();
120 else
121 Offset -= AdditionalOffset.getZExtValue();
122
123 return APValue(ResultLValue.getLValueBase(), Offset);
124}
125
126
Chris Lattnera42f09a2008-07-11 19:10:17 +0000127APValue PointerExprEvaluator::VisitCastExpr(const CastExpr* E) {
Chris Lattnera823ccf2008-07-11 18:11:29 +0000128 const Expr* SubExpr = E->getSubExpr();
129
130 // Check for pointer->pointer cast
131 if (SubExpr->getType()->isPointerType()) {
132 APValue Result;
Chris Lattner422373c2008-07-11 22:52:41 +0000133 if (EvaluatePointer(SubExpr, Result, Info))
Chris Lattnera823ccf2008-07-11 18:11:29 +0000134 return Result;
135 return APValue();
136 }
137
Eli Friedman3e64dd72008-07-27 05:46:18 +0000138 if (SubExpr->getType()->isIntegralType()) {
Chris Lattnera823ccf2008-07-11 18:11:29 +0000139 llvm::APSInt Result(32);
Chris Lattner422373c2008-07-11 22:52:41 +0000140 if (EvaluateInteger(SubExpr, Result, Info)) {
141 Result.extOrTrunc((unsigned)Info.Ctx.getTypeSize(E->getType()));
Chris Lattnera823ccf2008-07-11 18:11:29 +0000142 return APValue(0, Result.getZExtValue());
143 }
144 }
145
146 assert(0 && "Unhandled cast");
147 return APValue();
148}
149
150
151//===----------------------------------------------------------------------===//
152// Integer Evaluation
153//===----------------------------------------------------------------------===//
Chris Lattnera823ccf2008-07-11 18:11:29 +0000154
155namespace {
Anders Carlssoncad17b52008-07-08 05:13:58 +0000156class VISIBILITY_HIDDEN IntExprEvaluator
Chris Lattnera42f09a2008-07-11 19:10:17 +0000157 : public StmtVisitor<IntExprEvaluator, bool> {
Chris Lattner422373c2008-07-11 22:52:41 +0000158 EvalInfo &Info;
Chris Lattnera42f09a2008-07-11 19:10:17 +0000159 APSInt &Result;
Anders Carlssoncad17b52008-07-08 05:13:58 +0000160public:
Chris Lattner422373c2008-07-11 22:52:41 +0000161 IntExprEvaluator(EvalInfo &info, APSInt &result)
162 : Info(info), Result(result) {}
Chris Lattnera823ccf2008-07-11 18:11:29 +0000163
Chris Lattner2c99c712008-07-11 19:24:49 +0000164 unsigned getIntTypeSizeInBits(QualType T) const {
Chris Lattner82437da2008-07-12 00:14:42 +0000165 return (unsigned)Info.Ctx.getIntWidth(T);
166 }
167
168 bool Extension(SourceLocation L, diag::kind D) {
169 Info.DiagLoc = L;
170 Info.ICEDiag = D;
171 return true; // still a constant.
172 }
173
174 bool Error(SourceLocation L, diag::kind D) {
175 // If this is in an unevaluated portion of the subexpression, ignore the
176 // error.
177 if (!Info.isEvaluated)
178 return true;
179
180 Info.DiagLoc = L;
181 Info.ICEDiag = D;
182 return false;
Chris Lattner2c99c712008-07-11 19:24:49 +0000183 }
184
Anders Carlssoncad17b52008-07-08 05:13:58 +0000185 //===--------------------------------------------------------------------===//
186 // Visitor Methods
187 //===--------------------------------------------------------------------===//
Chris Lattner2c99c712008-07-11 19:24:49 +0000188
Chris Lattnera42f09a2008-07-11 19:10:17 +0000189 bool VisitStmt(Stmt *S) {
Chris Lattner82437da2008-07-12 00:14:42 +0000190 return Error(S->getLocStart(), diag::err_expr_not_constant);
Anders Carlssoncad17b52008-07-08 05:13:58 +0000191 }
192
Chris Lattnera42f09a2008-07-11 19:10:17 +0000193 bool VisitParenExpr(ParenExpr *E) { return Visit(E->getSubExpr()); }
Anders Carlssoncad17b52008-07-08 05:13:58 +0000194
Chris Lattner15e59112008-07-12 00:38:25 +0000195 bool VisitIntegerLiteral(const IntegerLiteral *E) {
196 Result = E->getValue();
197 Result.setIsUnsigned(E->getType()->isUnsignedIntegerType());
198 return true;
199 }
200 bool VisitCharacterLiteral(const CharacterLiteral *E) {
201 Result.zextOrTrunc(getIntTypeSizeInBits(E->getType()));
202 Result = E->getValue();
203 Result.setIsUnsigned(E->getType()->isUnsignedIntegerType());
204 return true;
205 }
206 bool VisitTypesCompatibleExpr(const TypesCompatibleExpr *E) {
207 Result.zextOrTrunc(getIntTypeSizeInBits(E->getType()));
Daniel Dunbarda8ebd22008-10-24 08:07:57 +0000208 // Per gcc docs "this built-in function ignores top level
209 // qualifiers". We need to use the canonical version to properly
210 // be able to strip CRV qualifiers from the type.
211 QualType T0 = Info.Ctx.getCanonicalType(E->getArgType1());
212 QualType T1 = Info.Ctx.getCanonicalType(E->getArgType2());
213 Result = Info.Ctx.typesAreCompatible(T0.getUnqualifiedType(),
214 T1.getUnqualifiedType());
Chris Lattner15e59112008-07-12 00:38:25 +0000215 return true;
216 }
217 bool VisitDeclRefExpr(const DeclRefExpr *E);
218 bool VisitCallExpr(const CallExpr *E);
Chris Lattnera42f09a2008-07-11 19:10:17 +0000219 bool VisitBinaryOperator(const BinaryOperator *E);
220 bool VisitUnaryOperator(const UnaryOperator *E);
Anders Carlssonc0328012008-07-08 05:49:43 +0000221
Chris Lattnerff579ff2008-07-12 01:15:53 +0000222 bool VisitCastExpr(CastExpr* E) {
Chris Lattnerff579ff2008-07-12 01:15:53 +0000223 return HandleCast(E->getLocStart(), E->getSubExpr(), E->getType());
Anders Carlssonc43f44b2008-07-08 15:34:11 +0000224 }
Chris Lattner265a0892008-07-11 21:24:13 +0000225 bool VisitSizeOfAlignOfTypeExpr(const SizeOfAlignOfTypeExpr *E) {
Chris Lattner82437da2008-07-12 00:14:42 +0000226 return EvaluateSizeAlignOf(E->isSizeOf(), E->getArgumentType(),
227 E->getType());
Chris Lattner265a0892008-07-11 21:24:13 +0000228 }
Chris Lattner15e59112008-07-12 00:38:25 +0000229
Chris Lattner265a0892008-07-11 21:24:13 +0000230private:
Chris Lattnerff579ff2008-07-12 01:15:53 +0000231 bool HandleCast(SourceLocation CastLoc, Expr *SubExpr, QualType DestType);
Chris Lattner265a0892008-07-11 21:24:13 +0000232 bool EvaluateSizeAlignOf(bool isSizeOf, QualType SrcTy, QualType DstTy);
Anders Carlssond1aa5812008-07-08 14:35:21 +0000233};
Chris Lattnera823ccf2008-07-11 18:11:29 +0000234} // end anonymous namespace
Anders Carlssonc43f44b2008-07-08 15:34:11 +0000235
Chris Lattner422373c2008-07-11 22:52:41 +0000236static bool EvaluateInteger(const Expr* E, APSInt &Result, EvalInfo &Info) {
237 return IntExprEvaluator(Info, Result).Visit(const_cast<Expr*>(E));
Anders Carlssonc43f44b2008-07-08 15:34:11 +0000238}
Anders Carlssonc43f44b2008-07-08 15:34:11 +0000239
Chris Lattner15e59112008-07-12 00:38:25 +0000240bool IntExprEvaluator::VisitDeclRefExpr(const DeclRefExpr *E) {
241 // Enums are integer constant exprs.
242 if (const EnumConstantDecl *D = dyn_cast<EnumConstantDecl>(E->getDecl())) {
243 Result = D->getInitVal();
244 return true;
245 }
246
247 // Otherwise, random variable references are not constants.
248 return Error(E->getLocStart(), diag::err_expr_not_constant);
249}
250
Chris Lattner1eee9402008-10-06 06:40:35 +0000251/// EvaluateBuiltinClassifyType - Evaluate __builtin_classify_type the same way
252/// as GCC.
253static int EvaluateBuiltinClassifyType(const CallExpr *E) {
254 // The following enum mimics the values returned by GCC.
255 enum gcc_type_class {
256 no_type_class = -1,
257 void_type_class, integer_type_class, char_type_class,
258 enumeral_type_class, boolean_type_class,
259 pointer_type_class, reference_type_class, offset_type_class,
260 real_type_class, complex_type_class,
261 function_type_class, method_type_class,
262 record_type_class, union_type_class,
263 array_type_class, string_type_class,
264 lang_type_class
265 };
266
267 // If no argument was supplied, default to "no_type_class". This isn't
268 // ideal, however it is what gcc does.
269 if (E->getNumArgs() == 0)
270 return no_type_class;
271
272 QualType ArgTy = E->getArg(0)->getType();
273 if (ArgTy->isVoidType())
274 return void_type_class;
275 else if (ArgTy->isEnumeralType())
276 return enumeral_type_class;
277 else if (ArgTy->isBooleanType())
278 return boolean_type_class;
279 else if (ArgTy->isCharType())
280 return string_type_class; // gcc doesn't appear to use char_type_class
281 else if (ArgTy->isIntegerType())
282 return integer_type_class;
283 else if (ArgTy->isPointerType())
284 return pointer_type_class;
285 else if (ArgTy->isReferenceType())
286 return reference_type_class;
287 else if (ArgTy->isRealType())
288 return real_type_class;
289 else if (ArgTy->isComplexType())
290 return complex_type_class;
291 else if (ArgTy->isFunctionType())
292 return function_type_class;
293 else if (ArgTy->isStructureType())
294 return record_type_class;
295 else if (ArgTy->isUnionType())
296 return union_type_class;
297 else if (ArgTy->isArrayType())
298 return array_type_class;
299 else if (ArgTy->isUnionType())
300 return union_type_class;
301 else // FIXME: offset_type_class, method_type_class, & lang_type_class?
302 assert(0 && "CallExpr::isBuiltinClassifyType(): unimplemented type");
303 return -1;
304}
305
Chris Lattner15e59112008-07-12 00:38:25 +0000306bool IntExprEvaluator::VisitCallExpr(const CallExpr *E) {
307 Result.zextOrTrunc(getIntTypeSizeInBits(E->getType()));
Chris Lattner15e59112008-07-12 00:38:25 +0000308
Chris Lattner87293782008-10-06 05:28:25 +0000309 switch (E->isBuiltinCall()) {
310 default:
311 return Error(E->getLocStart(), diag::err_expr_not_constant);
312 case Builtin::BI__builtin_classify_type:
Chris Lattner1eee9402008-10-06 06:40:35 +0000313 Result.setIsSigned(true);
314 Result = EvaluateBuiltinClassifyType(E);
Chris Lattner87293782008-10-06 05:28:25 +0000315 return true;
316
317 case Builtin::BI__builtin_constant_p: {
318 // __builtin_constant_p always has one operand: it returns true if that
319 // operand can be folded, false otherwise.
320 APValue Res;
321 Result = E->getArg(0)->tryEvaluate(Res, Info.Ctx);
322 return true;
323 }
324 }
Chris Lattner15e59112008-07-12 00:38:25 +0000325}
Anders Carlssonc43f44b2008-07-08 15:34:11 +0000326
Chris Lattnera42f09a2008-07-11 19:10:17 +0000327bool IntExprEvaluator::VisitBinaryOperator(const BinaryOperator *E) {
Anders Carlssond1aa5812008-07-08 14:35:21 +0000328 // The LHS of a constant expr is always evaluated and needed.
Anders Carlssond1aa5812008-07-08 14:35:21 +0000329 llvm::APSInt RHS(32);
Chris Lattner82437da2008-07-12 00:14:42 +0000330 if (!Visit(E->getLHS()))
331 return false; // error in subexpression.
332
333 bool OldEval = Info.isEvaluated;
334
335 // The short-circuiting &&/|| operators don't necessarily evaluate their
336 // RHS. Make sure to pass isEvaluated down correctly.
337 if ((E->getOpcode() == BinaryOperator::LAnd && Result == 0) ||
338 (E->getOpcode() == BinaryOperator::LOr && Result != 0))
339 Info.isEvaluated = false;
Eli Friedman3e64dd72008-07-27 05:46:18 +0000340
341 // FIXME: Handle pointer subtraction
342
343 // FIXME Maybe we want to succeed even where we can't evaluate the
344 // right side of LAnd/LOr?
345 // For example, see http://llvm.org/bugs/show_bug.cgi?id=2525
Chris Lattner82437da2008-07-12 00:14:42 +0000346 if (!EvaluateInteger(E->getRHS(), RHS, Info))
Chris Lattnera42f09a2008-07-11 19:10:17 +0000347 return false;
Chris Lattner82437da2008-07-12 00:14:42 +0000348 Info.isEvaluated = OldEval;
Anders Carlssond1aa5812008-07-08 14:35:21 +0000349
350 switch (E->getOpcode()) {
Chris Lattner82437da2008-07-12 00:14:42 +0000351 default: return Error(E->getOperatorLoc(), diag::err_expr_not_constant);
352 case BinaryOperator::Mul: Result *= RHS; return true;
353 case BinaryOperator::Add: Result += RHS; return true;
354 case BinaryOperator::Sub: Result -= RHS; return true;
355 case BinaryOperator::And: Result &= RHS; return true;
356 case BinaryOperator::Xor: Result ^= RHS; return true;
357 case BinaryOperator::Or: Result |= RHS; return true;
Chris Lattner400d7402008-07-11 22:15:16 +0000358 case BinaryOperator::Div:
Chris Lattner82437da2008-07-12 00:14:42 +0000359 if (RHS == 0)
360 return Error(E->getOperatorLoc(), diag::err_expr_divide_by_zero);
Chris Lattner400d7402008-07-11 22:15:16 +0000361 Result /= RHS;
Chris Lattner82437da2008-07-12 00:14:42 +0000362 return true;
Chris Lattner400d7402008-07-11 22:15:16 +0000363 case BinaryOperator::Rem:
Chris Lattner82437da2008-07-12 00:14:42 +0000364 if (RHS == 0)
365 return Error(E->getOperatorLoc(), diag::err_expr_divide_by_zero);
Chris Lattner400d7402008-07-11 22:15:16 +0000366 Result %= RHS;
Chris Lattner82437da2008-07-12 00:14:42 +0000367 return true;
Anders Carlssond1aa5812008-07-08 14:35:21 +0000368 case BinaryOperator::Shl:
Chris Lattner82437da2008-07-12 00:14:42 +0000369 // FIXME: Warn about out of range shift amounts!
Chris Lattnera42f09a2008-07-11 19:10:17 +0000370 Result <<= (unsigned)RHS.getLimitedValue(Result.getBitWidth()-1);
Anders Carlssond1aa5812008-07-08 14:35:21 +0000371 break;
372 case BinaryOperator::Shr:
Chris Lattnera42f09a2008-07-11 19:10:17 +0000373 Result >>= (unsigned)RHS.getLimitedValue(Result.getBitWidth()-1);
Anders Carlssond1aa5812008-07-08 14:35:21 +0000374 break;
Chris Lattnera42f09a2008-07-11 19:10:17 +0000375
Chris Lattner045502c2008-07-11 19:29:32 +0000376 case BinaryOperator::LT:
377 Result = Result < RHS;
378 Result.zextOrTrunc(getIntTypeSizeInBits(E->getType()));
379 break;
380 case BinaryOperator::GT:
381 Result = Result > RHS;
382 Result.zextOrTrunc(getIntTypeSizeInBits(E->getType()));
383 break;
384 case BinaryOperator::LE:
385 Result = Result <= RHS;
386 Result.zextOrTrunc(getIntTypeSizeInBits(E->getType()));
387 break;
388 case BinaryOperator::GE:
389 Result = Result >= RHS;
390 Result.zextOrTrunc(getIntTypeSizeInBits(E->getType()));
391 break;
392 case BinaryOperator::EQ:
393 Result = Result == RHS;
394 Result.zextOrTrunc(getIntTypeSizeInBits(E->getType()));
395 break;
396 case BinaryOperator::NE:
397 Result = Result != RHS;
398 Result.zextOrTrunc(getIntTypeSizeInBits(E->getType()));
399 break;
Chris Lattner82437da2008-07-12 00:14:42 +0000400 case BinaryOperator::LAnd:
401 Result = Result != 0 && RHS != 0;
402 Result.zextOrTrunc(getIntTypeSizeInBits(E->getType()));
403 break;
404 case BinaryOperator::LOr:
405 Result = Result != 0 || RHS != 0;
406 Result.zextOrTrunc(getIntTypeSizeInBits(E->getType()));
407 break;
408
Anders Carlssonc0328012008-07-08 05:49:43 +0000409
Anders Carlssond1aa5812008-07-08 14:35:21 +0000410 case BinaryOperator::Comma:
Chris Lattner82437da2008-07-12 00:14:42 +0000411 // Result of the comma is just the result of the RHS.
412 Result = RHS;
413
Anders Carlssond1aa5812008-07-08 14:35:21 +0000414 // C99 6.6p3: "shall not contain assignment, ..., or comma operators,
415 // *except* when they are contained within a subexpression that is not
416 // evaluated". Note that Assignment can never happen due to constraints
417 // on the LHS subexpr, so we don't need to check it here.
Chris Lattner82437da2008-07-12 00:14:42 +0000418 if (!Info.isEvaluated)
419 return true;
420
421 // If the value is evaluated, we can accept it as an extension.
422 return Extension(E->getOperatorLoc(), diag::ext_comma_in_constant_expr);
Anders Carlssond1aa5812008-07-08 14:35:21 +0000423 }
424
425 Result.setIsUnsigned(E->getType()->isUnsignedIntegerType());
Chris Lattnera42f09a2008-07-11 19:10:17 +0000426 return true;
Anders Carlssond1aa5812008-07-08 14:35:21 +0000427}
428
Chris Lattner265a0892008-07-11 21:24:13 +0000429/// EvaluateSizeAlignOf - Evaluate sizeof(SrcTy) or alignof(SrcTy) with a result
430/// as a DstTy type.
431bool IntExprEvaluator::EvaluateSizeAlignOf(bool isSizeOf, QualType SrcTy,
432 QualType DstTy) {
433 // Return the result in the right width.
434 Result.zextOrTrunc(getIntTypeSizeInBits(DstTy));
435 Result.setIsUnsigned(DstTy->isUnsignedIntegerType());
436
437 // sizeof(void) and __alignof__(void) = 1 as a gcc extension.
438 if (SrcTy->isVoidType())
439 Result = 1;
440
441 // sizeof(vla) is not a constantexpr: C99 6.5.3.4p2.
442 if (!SrcTy->isConstantSizeType()) {
443 // FIXME: Should we attempt to evaluate this?
444 return false;
445 }
446
447 // GCC extension: sizeof(function) = 1.
448 if (SrcTy->isFunctionType()) {
449 // FIXME: AlignOf shouldn't be unconditionally 4!
450 Result = isSizeOf ? 1 : 4;
451 return true;
452 }
453
454 // Get information about the size or align.
Chris Lattner422373c2008-07-11 22:52:41 +0000455 unsigned CharSize = Info.Ctx.Target.getCharWidth();
Chris Lattner265a0892008-07-11 21:24:13 +0000456 if (isSizeOf)
457 Result = getIntTypeSizeInBits(SrcTy) / CharSize;
458 else
Chris Lattner422373c2008-07-11 22:52:41 +0000459 Result = Info.Ctx.getTypeAlign(SrcTy) / CharSize;
Chris Lattner265a0892008-07-11 21:24:13 +0000460 return true;
461}
462
Chris Lattnera42f09a2008-07-11 19:10:17 +0000463bool IntExprEvaluator::VisitUnaryOperator(const UnaryOperator *E) {
Chris Lattner15e59112008-07-12 00:38:25 +0000464 // Special case unary operators that do not need their subexpression
465 // evaluated. offsetof/sizeof/alignof are all special.
Chris Lattner400d7402008-07-11 22:15:16 +0000466 if (E->isOffsetOfOp()) {
Chris Lattner15e59112008-07-12 00:38:25 +0000467 Result.zextOrTrunc(getIntTypeSizeInBits(E->getType()));
Chris Lattner422373c2008-07-11 22:52:41 +0000468 Result = E->evaluateOffsetOf(Info.Ctx);
Chris Lattner400d7402008-07-11 22:15:16 +0000469 Result.setIsUnsigned(E->getType()->isUnsignedIntegerType());
470 return true;
471 }
472
473 if (E->isSizeOfAlignOfOp())
Chris Lattner265a0892008-07-11 21:24:13 +0000474 return EvaluateSizeAlignOf(E->getOpcode() == UnaryOperator::SizeOf,
475 E->getSubExpr()->getType(), E->getType());
Chris Lattner400d7402008-07-11 22:15:16 +0000476
Chris Lattner422373c2008-07-11 22:52:41 +0000477 // Get the operand value into 'Result'.
478 if (!Visit(E->getSubExpr()))
Chris Lattner400d7402008-07-11 22:15:16 +0000479 return false;
Anders Carlssond1aa5812008-07-08 14:35:21 +0000480
Chris Lattner400d7402008-07-11 22:15:16 +0000481 switch (E->getOpcode()) {
Chris Lattner15e59112008-07-12 00:38:25 +0000482 default:
Chris Lattner400d7402008-07-11 22:15:16 +0000483 // Address, indirect, pre/post inc/dec, etc are not valid constant exprs.
484 // See C99 6.6p3.
Chris Lattner15e59112008-07-12 00:38:25 +0000485 return Error(E->getOperatorLoc(), diag::err_expr_not_constant);
Chris Lattner400d7402008-07-11 22:15:16 +0000486 case UnaryOperator::LNot: {
487 bool Val = Result == 0;
488 Result.zextOrTrunc(getIntTypeSizeInBits(E->getType()));
489 Result = Val;
490 break;
491 }
492 case UnaryOperator::Extension:
Chris Lattner15e59112008-07-12 00:38:25 +0000493 // FIXME: Should extension allow i-c-e extension expressions in its scope?
494 // If so, we could clear the diagnostic ID.
Chris Lattner400d7402008-07-11 22:15:16 +0000495 case UnaryOperator::Plus:
Chris Lattner15e59112008-07-12 00:38:25 +0000496 // The result is always just the subexpr.
Chris Lattner400d7402008-07-11 22:15:16 +0000497 break;
498 case UnaryOperator::Minus:
499 Result = -Result;
500 break;
501 case UnaryOperator::Not:
502 Result = ~Result;
503 break;
Anders Carlssond1aa5812008-07-08 14:35:21 +0000504 }
505
506 Result.setIsUnsigned(E->getType()->isUnsignedIntegerType());
Chris Lattnera42f09a2008-07-11 19:10:17 +0000507 return true;
Anders Carlssond1aa5812008-07-08 14:35:21 +0000508}
509
Chris Lattnerff579ff2008-07-12 01:15:53 +0000510/// HandleCast - This is used to evaluate implicit or explicit casts where the
511/// result type is integer.
512bool IntExprEvaluator::HandleCast(SourceLocation CastLoc,
513 Expr *SubExpr, QualType DestType) {
Chris Lattner2c99c712008-07-11 19:24:49 +0000514 unsigned DestWidth = getIntTypeSizeInBits(DestType);
Anders Carlssond1aa5812008-07-08 14:35:21 +0000515
516 // Handle simple integer->integer casts.
517 if (SubExpr->getType()->isIntegerType()) {
Chris Lattnerff579ff2008-07-12 01:15:53 +0000518 if (!Visit(SubExpr))
Chris Lattnera42f09a2008-07-11 19:10:17 +0000519 return false;
Anders Carlssond1aa5812008-07-08 14:35:21 +0000520
521 // Figure out if this is a truncate, extend or noop cast.
522 // If the input is signed, do a sign extend, noop, or truncate.
523 if (DestType->isBooleanType()) {
524 // Conversion to bool compares against zero.
525 Result = Result != 0;
526 Result.zextOrTrunc(DestWidth);
Chris Lattner2c99c712008-07-11 19:24:49 +0000527 } else
Anders Carlssond1aa5812008-07-08 14:35:21 +0000528 Result.extOrTrunc(DestWidth);
Chris Lattnerff579ff2008-07-12 01:15:53 +0000529 Result.setIsUnsigned(DestType->isUnsignedIntegerType());
530 return true;
531 }
532
533 // FIXME: Clean this up!
534 if (SubExpr->getType()->isPointerType()) {
Anders Carlssond1aa5812008-07-08 14:35:21 +0000535 APValue LV;
Chris Lattner422373c2008-07-11 22:52:41 +0000536 if (!EvaluatePointer(SubExpr, LV, Info))
Chris Lattnera42f09a2008-07-11 19:10:17 +0000537 return false;
Anders Carlssond1aa5812008-07-08 14:35:21 +0000538 if (LV.getLValueBase())
Chris Lattnera42f09a2008-07-11 19:10:17 +0000539 return false;
Anders Carlssonc0328012008-07-08 05:49:43 +0000540
Anders Carlsson8ab15c82008-07-08 16:49:00 +0000541 Result.extOrTrunc(DestWidth);
542 Result = LV.getLValueOffset();
Chris Lattnerff579ff2008-07-12 01:15:53 +0000543 Result.setIsUnsigned(DestType->isUnsignedIntegerType());
544 return true;
Anders Carlsson02a34c32008-07-08 14:30:00 +0000545 }
546
Chris Lattnerff579ff2008-07-12 01:15:53 +0000547 if (!SubExpr->getType()->isRealFloatingType())
548 return Error(CastLoc, diag::err_expr_not_constant);
549
Eli Friedman2f445492008-08-22 00:06:13 +0000550 APFloat F(0.0);
551 if (!EvaluateFloat(SubExpr, F, Info))
Chris Lattnerff579ff2008-07-12 01:15:53 +0000552 return Error(CastLoc, diag::err_expr_not_constant);
Eli Friedman2f445492008-08-22 00:06:13 +0000553
Chris Lattnerff579ff2008-07-12 01:15:53 +0000554 // If the destination is boolean, compare against zero.
555 if (DestType->isBooleanType()) {
Eli Friedman2f445492008-08-22 00:06:13 +0000556 Result = !F.isZero();
Chris Lattnerff579ff2008-07-12 01:15:53 +0000557 Result.zextOrTrunc(DestWidth);
558 Result.setIsUnsigned(DestType->isUnsignedIntegerType());
559 return true;
560 }
561
562 // Determine whether we are converting to unsigned or signed.
563 bool DestSigned = DestType->isSignedIntegerType();
564
565 // FIXME: Warning for overflow.
Dale Johannesen2461f612008-10-09 23:02:32 +0000566 uint64_t Space[4];
567 bool ignored;
Eli Friedman2f445492008-08-22 00:06:13 +0000568 (void)F.convertToInteger(Space, DestWidth, DestSigned,
Dale Johannesen2461f612008-10-09 23:02:32 +0000569 llvm::APFloat::rmTowardZero, &ignored);
Chris Lattnerff579ff2008-07-12 01:15:53 +0000570 Result = llvm::APInt(DestWidth, 4, Space);
571 Result.setIsUnsigned(!DestSigned);
Chris Lattnera42f09a2008-07-11 19:10:17 +0000572 return true;
Anders Carlssond1aa5812008-07-08 14:35:21 +0000573}
Anders Carlsson02a34c32008-07-08 14:30:00 +0000574
Chris Lattnera823ccf2008-07-11 18:11:29 +0000575//===----------------------------------------------------------------------===//
Eli Friedman2f445492008-08-22 00:06:13 +0000576// Float Evaluation
577//===----------------------------------------------------------------------===//
578
579namespace {
580class VISIBILITY_HIDDEN FloatExprEvaluator
581 : public StmtVisitor<FloatExprEvaluator, bool> {
582 EvalInfo &Info;
583 APFloat &Result;
584public:
585 FloatExprEvaluator(EvalInfo &info, APFloat &result)
586 : Info(info), Result(result) {}
587
588 bool VisitStmt(Stmt *S) {
589 return false;
590 }
591
592 bool VisitParenExpr(ParenExpr *E) { return Visit(E->getSubExpr()); }
Chris Lattner87293782008-10-06 05:28:25 +0000593 bool VisitCallExpr(const CallExpr *E);
Eli Friedman2f445492008-08-22 00:06:13 +0000594
Daniel Dunbar804ead02008-10-16 03:51:50 +0000595 bool VisitUnaryOperator(const UnaryOperator *E);
Eli Friedman2f445492008-08-22 00:06:13 +0000596 bool VisitBinaryOperator(const BinaryOperator *E);
597 bool VisitFloatingLiteral(const FloatingLiteral *E);
598};
599} // end anonymous namespace
600
601static bool EvaluateFloat(const Expr* E, APFloat& Result, EvalInfo &Info) {
602 return FloatExprEvaluator(Info, Result).Visit(const_cast<Expr*>(E));
603}
604
Chris Lattner87293782008-10-06 05:28:25 +0000605bool FloatExprEvaluator::VisitCallExpr(const CallExpr *E) {
Chris Lattner87293782008-10-06 05:28:25 +0000606 switch (E->isBuiltinCall()) {
Chris Lattner27cde262008-10-06 05:53:16 +0000607 default: return false;
Chris Lattner87293782008-10-06 05:28:25 +0000608 case Builtin::BI__builtin_huge_val:
609 case Builtin::BI__builtin_huge_valf:
610 case Builtin::BI__builtin_huge_vall:
611 case Builtin::BI__builtin_inf:
612 case Builtin::BI__builtin_inff:
Daniel Dunbar0b3efb42008-10-14 05:41:12 +0000613 case Builtin::BI__builtin_infl: {
614 const llvm::fltSemantics &Sem =
615 Info.Ctx.getFloatTypeSemantics(E->getType());
Chris Lattner27cde262008-10-06 05:53:16 +0000616 Result = llvm::APFloat::getInf(Sem);
617 return true;
Daniel Dunbar0b3efb42008-10-14 05:41:12 +0000618 }
Chris Lattner667e1ee2008-10-06 06:31:58 +0000619
620 case Builtin::BI__builtin_nan:
621 case Builtin::BI__builtin_nanf:
622 case Builtin::BI__builtin_nanl:
623 // If this is __builtin_nan("") turn this into a simple nan, otherwise we
624 // can't constant fold it.
625 if (const StringLiteral *S =
626 dyn_cast<StringLiteral>(E->getArg(0)->IgnoreParenCasts())) {
627 if (!S->isWide() && S->getByteLength() == 0) { // empty string.
Daniel Dunbar0b3efb42008-10-14 05:41:12 +0000628 const llvm::fltSemantics &Sem =
629 Info.Ctx.getFloatTypeSemantics(E->getType());
Chris Lattner667e1ee2008-10-06 06:31:58 +0000630 Result = llvm::APFloat::getNaN(Sem);
631 return true;
632 }
633 }
634 return false;
Daniel Dunbar804ead02008-10-16 03:51:50 +0000635
636 case Builtin::BI__builtin_fabs:
637 case Builtin::BI__builtin_fabsf:
638 case Builtin::BI__builtin_fabsl:
639 if (!EvaluateFloat(E->getArg(0), Result, Info))
640 return false;
641
642 if (Result.isNegative())
643 Result.changeSign();
644 return true;
645
646 case Builtin::BI__builtin_copysign:
647 case Builtin::BI__builtin_copysignf:
648 case Builtin::BI__builtin_copysignl: {
649 APFloat RHS(0.);
650 if (!EvaluateFloat(E->getArg(0), Result, Info) ||
651 !EvaluateFloat(E->getArg(1), RHS, Info))
652 return false;
653 Result.copySign(RHS);
654 return true;
655 }
Chris Lattner87293782008-10-06 05:28:25 +0000656 }
657}
658
Daniel Dunbar804ead02008-10-16 03:51:50 +0000659bool FloatExprEvaluator::VisitUnaryOperator(const UnaryOperator *E) {
660 if (!EvaluateFloat(E->getSubExpr(), Result, Info))
661 return false;
662
663 switch (E->getOpcode()) {
664 default: return false;
665 case UnaryOperator::Plus:
666 return true;
667 case UnaryOperator::Minus:
668 Result.changeSign();
669 return true;
670 }
671}
Chris Lattner87293782008-10-06 05:28:25 +0000672
Eli Friedman2f445492008-08-22 00:06:13 +0000673bool FloatExprEvaluator::VisitBinaryOperator(const BinaryOperator *E) {
674 // FIXME: Diagnostics? I really don't understand how the warnings
675 // and errors are supposed to work.
Daniel Dunbar804ead02008-10-16 03:51:50 +0000676 APFloat RHS(0.0);
Eli Friedman2f445492008-08-22 00:06:13 +0000677 if (!EvaluateFloat(E->getLHS(), Result, Info))
678 return false;
679 if (!EvaluateFloat(E->getRHS(), RHS, Info))
680 return false;
681
682 switch (E->getOpcode()) {
683 default: return false;
684 case BinaryOperator::Mul:
685 Result.multiply(RHS, APFloat::rmNearestTiesToEven);
686 return true;
687 case BinaryOperator::Add:
688 Result.add(RHS, APFloat::rmNearestTiesToEven);
689 return true;
690 case BinaryOperator::Sub:
691 Result.subtract(RHS, APFloat::rmNearestTiesToEven);
692 return true;
693 case BinaryOperator::Div:
694 Result.divide(RHS, APFloat::rmNearestTiesToEven);
695 return true;
696 case BinaryOperator::Rem:
697 Result.mod(RHS, APFloat::rmNearestTiesToEven);
698 return true;
699 }
700}
701
702bool FloatExprEvaluator::VisitFloatingLiteral(const FloatingLiteral *E) {
703 Result = E->getValue();
704 return true;
705}
706
707//===----------------------------------------------------------------------===//
Chris Lattnera823ccf2008-07-11 18:11:29 +0000708// Top level TryEvaluate.
709//===----------------------------------------------------------------------===//
710
Chris Lattner87293782008-10-06 05:28:25 +0000711/// tryEvaluate - Return true if this is a constant which we can fold using
712/// any crazy technique (that has nothing to do with language standards) that
713/// we want to. If this function returns true, it returns the folded constant
714/// in Result.
Chris Lattnera42f09a2008-07-11 19:10:17 +0000715bool Expr::tryEvaluate(APValue &Result, ASTContext &Ctx) const {
Chris Lattner422373c2008-07-11 22:52:41 +0000716 EvalInfo Info(Ctx);
Anders Carlssonc0328012008-07-08 05:49:43 +0000717 if (getType()->isIntegerType()) {
Eli Friedman2f445492008-08-22 00:06:13 +0000718 llvm::APSInt sInt(32);
Chris Lattner422373c2008-07-11 22:52:41 +0000719 if (EvaluateInteger(this, sInt, Info)) {
Anders Carlssonc0328012008-07-08 05:49:43 +0000720 Result = APValue(sInt);
721 return true;
722 }
Eli Friedman2f445492008-08-22 00:06:13 +0000723 } else if (getType()->isPointerType()) {
724 if (EvaluatePointer(this, Result, Info)) {
725 return true;
726 }
727 } else if (getType()->isRealFloatingType()) {
728 llvm::APFloat f(0.0);
729 if (EvaluateFloat(this, f, Info)) {
730 Result = APValue(f);
731 return true;
732 }
733 }
Anders Carlsson47968a92008-08-10 17:03:01 +0000734
Anders Carlssonc7436af2008-07-03 04:20:39 +0000735 return false;
736}
Chris Lattner2d9a3f62008-10-06 06:49:02 +0000737
738/// isEvaluatable - Call tryEvaluate to see if this expression can be constant
739/// folded, but discard the result.
740bool Expr::isEvaluatable(ASTContext &Ctx) const {
741 APValue V;
742 return tryEvaluate(V, Ctx);
743}