1fa0734ecSArgyrios Kyrtzidis // SimpleSValBuilder.cpp - A basic SValBuilder -----------------------*- C++ -*-
2fa0734ecSArgyrios Kyrtzidis //
32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information.
52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6fa0734ecSArgyrios Kyrtzidis //
7fa0734ecSArgyrios Kyrtzidis //===----------------------------------------------------------------------===//
8fa0734ecSArgyrios Kyrtzidis //
9fa0734ecSArgyrios Kyrtzidis //  This file defines SimpleSValBuilder, a basic implementation of SValBuilder.
10fa0734ecSArgyrios Kyrtzidis //
11fa0734ecSArgyrios Kyrtzidis //===----------------------------------------------------------------------===//
12fa0734ecSArgyrios Kyrtzidis 
13f8cbac4bSTed Kremenek #include "clang/StaticAnalyzer/Core/PathSensitive/SValBuilder.h"
143a02247dSChandler Carruth #include "clang/StaticAnalyzer/Core/PathSensitive/APSIntType.h"
15d70ec366SAdam Balogh #include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h"
16001fd5b4STed Kremenek #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h"
1712294f8dSArtem Dergachev #include "clang/StaticAnalyzer/Core/PathSensitive/SValVisitor.h"
18fa0734ecSArgyrios Kyrtzidis 
19fa0734ecSArgyrios Kyrtzidis using namespace clang;
20fa0734ecSArgyrios Kyrtzidis using namespace ento;
21fa0734ecSArgyrios Kyrtzidis 
22fa0734ecSArgyrios Kyrtzidis namespace {
23fa0734ecSArgyrios Kyrtzidis class SimpleSValBuilder : public SValBuilder {
24978431e8SGabor Marton 
25978431e8SGabor Marton   // With one `simplifySValOnce` call, a compound symbols might collapse to
26978431e8SGabor Marton   // simpler symbol tree that is still possible to further simplify. Thus, we
27978431e8SGabor Marton   // do the simplification on a new symbol tree until we reach the simplest
28978431e8SGabor Marton   // form, i.e. the fixpoint.
29978431e8SGabor Marton   // Consider the following symbol `(b * b) * b * b` which has this tree:
30978431e8SGabor Marton   //       *
31978431e8SGabor Marton   //      / \
32978431e8SGabor Marton   //     *   b
33978431e8SGabor Marton   //    /  \
34978431e8SGabor Marton   //   /    b
35978431e8SGabor Marton   // (b * b)
36978431e8SGabor Marton   // Now, if the `b * b == 1` new constraint is added then during the first
37978431e8SGabor Marton   // iteration we have the following transformations:
38978431e8SGabor Marton   //       *                  *
39978431e8SGabor Marton   //      / \                / \
40978431e8SGabor Marton   //     *   b     -->      b   b
41978431e8SGabor Marton   //    /  \
42978431e8SGabor Marton   //   /    b
43978431e8SGabor Marton   //  1
44978431e8SGabor Marton   // We need another iteration to reach the final result `1`.
45978431e8SGabor Marton   SVal simplifyUntilFixpoint(ProgramStateRef State, SVal Val);
46978431e8SGabor Marton 
47978431e8SGabor Marton   // Recursively descends into symbolic expressions and replaces symbols
48978431e8SGabor Marton   // with their known values (in the sense of the getKnownValue() method).
49978431e8SGabor Marton   // We traverse the symbol tree and query the constraint values for the
50978431e8SGabor Marton   // sub-trees and if a value is a constant we do the constant folding.
51978431e8SGabor Marton   SVal simplifySValOnce(ProgramStateRef State, SVal V);
52978431e8SGabor Marton 
53fa0734ecSArgyrios Kyrtzidis public:
54fa0734ecSArgyrios Kyrtzidis   SimpleSValBuilder(llvm::BumpPtrAllocator &alloc, ASTContext &context,
55001fd5b4STed Kremenek                     ProgramStateManager &stateMgr)
56fa0734ecSArgyrios Kyrtzidis       : SValBuilder(alloc, context, stateMgr) {}
57637d1e66SAngel Garcia Gomez   ~SimpleSValBuilder() override {}
58fa0734ecSArgyrios Kyrtzidis 
59fb6b25b5SCraig Topper   SVal evalMinus(NonLoc val) override;
60fb6b25b5SCraig Topper   SVal evalComplement(NonLoc val) override;
61fb6b25b5SCraig Topper   SVal evalBinOpNN(ProgramStateRef state, BinaryOperator::Opcode op,
62fb6b25b5SCraig Topper                    NonLoc lhs, NonLoc rhs, QualType resultTy) override;
63fb6b25b5SCraig Topper   SVal evalBinOpLL(ProgramStateRef state, BinaryOperator::Opcode op,
64fb6b25b5SCraig Topper                    Loc lhs, Loc rhs, QualType resultTy) override;
65fb6b25b5SCraig Topper   SVal evalBinOpLN(ProgramStateRef state, BinaryOperator::Opcode op,
66fb6b25b5SCraig Topper                    Loc lhs, NonLoc rhs, QualType resultTy) override;
67fa0734ecSArgyrios Kyrtzidis 
68fa0734ecSArgyrios Kyrtzidis   /// getKnownValue - evaluates a given SVal. If the SVal has only one possible
69fa0734ecSArgyrios Kyrtzidis   ///  (integer) value, that value is returned. Otherwise, returns NULL.
70fb6b25b5SCraig Topper   const llvm::APSInt *getKnownValue(ProgramStateRef state, SVal V) override;
71fa0734ecSArgyrios Kyrtzidis 
7212294f8dSArtem Dergachev   SVal simplifySVal(ProgramStateRef State, SVal V) override;
7312294f8dSArtem Dergachev 
74fa0734ecSArgyrios Kyrtzidis   SVal MakeSymIntVal(const SymExpr *LHS, BinaryOperator::Opcode op,
75fa0734ecSArgyrios Kyrtzidis                      const llvm::APSInt &RHS, QualType resultTy);
76fa0734ecSArgyrios Kyrtzidis };
77fa0734ecSArgyrios Kyrtzidis } // end anonymous namespace
78fa0734ecSArgyrios Kyrtzidis 
79fa0734ecSArgyrios Kyrtzidis SValBuilder *ento::createSimpleSValBuilder(llvm::BumpPtrAllocator &alloc,
80fa0734ecSArgyrios Kyrtzidis                                            ASTContext &context,
81001fd5b4STed Kremenek                                            ProgramStateManager &stateMgr) {
82fa0734ecSArgyrios Kyrtzidis   return new SimpleSValBuilder(alloc, context, stateMgr);
83fa0734ecSArgyrios Kyrtzidis }
84fa0734ecSArgyrios Kyrtzidis 
85fa0734ecSArgyrios Kyrtzidis //===----------------------------------------------------------------------===//
86fa0734ecSArgyrios Kyrtzidis // Transfer function for unary operators.
87fa0734ecSArgyrios Kyrtzidis //===----------------------------------------------------------------------===//
88fa0734ecSArgyrios Kyrtzidis 
89fa0734ecSArgyrios Kyrtzidis SVal SimpleSValBuilder::evalMinus(NonLoc val) {
90fa0734ecSArgyrios Kyrtzidis   switch (val.getSubKind()) {
91fa0734ecSArgyrios Kyrtzidis   case nonloc::ConcreteIntKind:
922fdacbc5SDavid Blaikie     return val.castAs<nonloc::ConcreteInt>().evalMinus(*this);
93fa0734ecSArgyrios Kyrtzidis   default:
94fa0734ecSArgyrios Kyrtzidis     return UnknownVal();
95fa0734ecSArgyrios Kyrtzidis   }
96fa0734ecSArgyrios Kyrtzidis }
97fa0734ecSArgyrios Kyrtzidis 
98fa0734ecSArgyrios Kyrtzidis SVal SimpleSValBuilder::evalComplement(NonLoc X) {
99fa0734ecSArgyrios Kyrtzidis   switch (X.getSubKind()) {
100fa0734ecSArgyrios Kyrtzidis   case nonloc::ConcreteIntKind:
1012fdacbc5SDavid Blaikie     return X.castAs<nonloc::ConcreteInt>().evalComplement(*this);
102fa0734ecSArgyrios Kyrtzidis   default:
103fa0734ecSArgyrios Kyrtzidis     return UnknownVal();
104fa0734ecSArgyrios Kyrtzidis   }
105fa0734ecSArgyrios Kyrtzidis }
106fa0734ecSArgyrios Kyrtzidis 
107fa0734ecSArgyrios Kyrtzidis //===----------------------------------------------------------------------===//
108fa0734ecSArgyrios Kyrtzidis // Transfer function for binary operators.
109fa0734ecSArgyrios Kyrtzidis //===----------------------------------------------------------------------===//
110fa0734ecSArgyrios Kyrtzidis 
111fa0734ecSArgyrios Kyrtzidis SVal SimpleSValBuilder::MakeSymIntVal(const SymExpr *LHS,
112fa0734ecSArgyrios Kyrtzidis                                     BinaryOperator::Opcode op,
113fa0734ecSArgyrios Kyrtzidis                                     const llvm::APSInt &RHS,
114fa0734ecSArgyrios Kyrtzidis                                     QualType resultTy) {
115fa0734ecSArgyrios Kyrtzidis   bool isIdempotent = false;
116fa0734ecSArgyrios Kyrtzidis 
117fa0734ecSArgyrios Kyrtzidis   // Check for a few special cases with known reductions first.
118fa0734ecSArgyrios Kyrtzidis   switch (op) {
119fa0734ecSArgyrios Kyrtzidis   default:
120fa0734ecSArgyrios Kyrtzidis     // We can't reduce this case; just treat it normally.
121fa0734ecSArgyrios Kyrtzidis     break;
122fa0734ecSArgyrios Kyrtzidis   case BO_Mul:
123fa0734ecSArgyrios Kyrtzidis     // a*0 and a*1
124fa0734ecSArgyrios Kyrtzidis     if (RHS == 0)
125fa0734ecSArgyrios Kyrtzidis       return makeIntVal(0, resultTy);
126fa0734ecSArgyrios Kyrtzidis     else if (RHS == 1)
127fa0734ecSArgyrios Kyrtzidis       isIdempotent = true;
128fa0734ecSArgyrios Kyrtzidis     break;
129fa0734ecSArgyrios Kyrtzidis   case BO_Div:
130fa0734ecSArgyrios Kyrtzidis     // a/0 and a/1
131fa0734ecSArgyrios Kyrtzidis     if (RHS == 0)
132fa0734ecSArgyrios Kyrtzidis       // This is also handled elsewhere.
133fa0734ecSArgyrios Kyrtzidis       return UndefinedVal();
134fa0734ecSArgyrios Kyrtzidis     else if (RHS == 1)
135fa0734ecSArgyrios Kyrtzidis       isIdempotent = true;
136fa0734ecSArgyrios Kyrtzidis     break;
137fa0734ecSArgyrios Kyrtzidis   case BO_Rem:
138fa0734ecSArgyrios Kyrtzidis     // a%0 and a%1
139fa0734ecSArgyrios Kyrtzidis     if (RHS == 0)
140fa0734ecSArgyrios Kyrtzidis       // This is also handled elsewhere.
141fa0734ecSArgyrios Kyrtzidis       return UndefinedVal();
142fa0734ecSArgyrios Kyrtzidis     else if (RHS == 1)
143fa0734ecSArgyrios Kyrtzidis       return makeIntVal(0, resultTy);
144fa0734ecSArgyrios Kyrtzidis     break;
145fa0734ecSArgyrios Kyrtzidis   case BO_Add:
146fa0734ecSArgyrios Kyrtzidis   case BO_Sub:
147fa0734ecSArgyrios Kyrtzidis   case BO_Shl:
148fa0734ecSArgyrios Kyrtzidis   case BO_Shr:
149fa0734ecSArgyrios Kyrtzidis   case BO_Xor:
150fa0734ecSArgyrios Kyrtzidis     // a+0, a-0, a<<0, a>>0, a^0
151fa0734ecSArgyrios Kyrtzidis     if (RHS == 0)
152fa0734ecSArgyrios Kyrtzidis       isIdempotent = true;
153fa0734ecSArgyrios Kyrtzidis     break;
154fa0734ecSArgyrios Kyrtzidis   case BO_And:
155fa0734ecSArgyrios Kyrtzidis     // a&0 and a&(~0)
156fa0734ecSArgyrios Kyrtzidis     if (RHS == 0)
157fa0734ecSArgyrios Kyrtzidis       return makeIntVal(0, resultTy);
158d933adeaSJay Foad     else if (RHS.isAllOnes())
159fa0734ecSArgyrios Kyrtzidis       isIdempotent = true;
160fa0734ecSArgyrios Kyrtzidis     break;
161fa0734ecSArgyrios Kyrtzidis   case BO_Or:
162fa0734ecSArgyrios Kyrtzidis     // a|0 and a|(~0)
163fa0734ecSArgyrios Kyrtzidis     if (RHS == 0)
164fa0734ecSArgyrios Kyrtzidis       isIdempotent = true;
165d933adeaSJay Foad     else if (RHS.isAllOnes()) {
166fa0734ecSArgyrios Kyrtzidis       const llvm::APSInt &Result = BasicVals.Convert(resultTy, RHS);
167fa0734ecSArgyrios Kyrtzidis       return nonloc::ConcreteInt(Result);
168fa0734ecSArgyrios Kyrtzidis     }
169fa0734ecSArgyrios Kyrtzidis     break;
170fa0734ecSArgyrios Kyrtzidis   }
171fa0734ecSArgyrios Kyrtzidis 
172fa0734ecSArgyrios Kyrtzidis   // Idempotent ops (like a*1) can still change the type of an expression.
17301ddfa95SDenys Petrov   // Wrap the LHS up in a NonLoc again and let evalCast do the
1745ad574c0SZhanyong Wan   // dirty work.
175d066f79cSAnna Zaks   if (isIdempotent)
17601ddfa95SDenys Petrov     return evalCast(nonloc::SymbolVal(LHS), resultTy, QualType{});
177fa0734ecSArgyrios Kyrtzidis 
178fa0734ecSArgyrios Kyrtzidis   // If we reach this point, the expression cannot be simplified.
17954569448SJordy Rose   // Make a SymbolVal for the entire expression, after converting the RHS.
18054569448SJordy Rose   const llvm::APSInt *ConvertedRHS = &RHS;
18154569448SJordy Rose   if (BinaryOperator::isComparisonOp(op)) {
18254569448SJordy Rose     // We're looking for a type big enough to compare the symbolic value
18354569448SJordy Rose     // with the given constant.
18454569448SJordy Rose     // FIXME: This is an approximation of Sema::UsualArithmeticConversions.
18554569448SJordy Rose     ASTContext &Ctx = getContext();
186a808e165STed Kremenek     QualType SymbolType = LHS->getType();
18754569448SJordy Rose     uint64_t ValWidth = RHS.getBitWidth();
18854569448SJordy Rose     uint64_t TypeWidth = Ctx.getTypeSize(SymbolType);
18954569448SJordy Rose 
19054569448SJordy Rose     if (ValWidth < TypeWidth) {
19154569448SJordy Rose       // If the value is too small, extend it.
19254569448SJordy Rose       ConvertedRHS = &BasicVals.Convert(SymbolType, RHS);
19354569448SJordy Rose     } else if (ValWidth == TypeWidth) {
19454569448SJordy Rose       // If the value is signed but the symbol is unsigned, do the comparison
19554569448SJordy Rose       // in unsigned space. [C99 6.3.1.8]
19654569448SJordy Rose       // (For the opposite case, the value is already unsigned.)
19754569448SJordy Rose       if (RHS.isSigned() && !SymbolType->isSignedIntegerOrEnumerationType())
19854569448SJordy Rose         ConvertedRHS = &BasicVals.Convert(SymbolType, RHS);
19954569448SJordy Rose     }
20054569448SJordy Rose   } else
20154569448SJordy Rose     ConvertedRHS = &BasicVals.Convert(resultTy, RHS);
20254569448SJordy Rose 
20354569448SJordy Rose   return makeNonLoc(LHS, op, *ConvertedRHS, resultTy);
204fa0734ecSArgyrios Kyrtzidis }
205fa0734ecSArgyrios Kyrtzidis 
2062bbccca9SAdam Balogh // See if Sym is known to be a relation Rel with Bound.
2072bbccca9SAdam Balogh static bool isInRelation(BinaryOperator::Opcode Rel, SymbolRef Sym,
2082bbccca9SAdam Balogh                          llvm::APSInt Bound, ProgramStateRef State) {
2092bbccca9SAdam Balogh   SValBuilder &SVB = State->getStateManager().getSValBuilder();
2102bbccca9SAdam Balogh   SVal Result =
2112bbccca9SAdam Balogh       SVB.evalBinOpNN(State, Rel, nonloc::SymbolVal(Sym),
2122bbccca9SAdam Balogh                       nonloc::ConcreteInt(Bound), SVB.getConditionType());
2132bbccca9SAdam Balogh   if (auto DV = Result.getAs<DefinedSVal>()) {
2142bbccca9SAdam Balogh     return !State->assume(*DV, false);
2152bbccca9SAdam Balogh   }
2162bbccca9SAdam Balogh   return false;
2172bbccca9SAdam Balogh }
2182bbccca9SAdam Balogh 
2192bbccca9SAdam Balogh // See if Sym is known to be within [min/4, max/4], where min and max
2202bbccca9SAdam Balogh // are the bounds of the symbol's integral type. With such symbols,
2212bbccca9SAdam Balogh // some manipulations can be performed without the risk of overflow.
2222bbccca9SAdam Balogh // assume() doesn't cause infinite recursion because we should be dealing
2232bbccca9SAdam Balogh // with simpler symbols on every recursive call.
2242bbccca9SAdam Balogh static bool isWithinConstantOverflowBounds(SymbolRef Sym,
2252bbccca9SAdam Balogh                                            ProgramStateRef State) {
2262bbccca9SAdam Balogh   SValBuilder &SVB = State->getStateManager().getSValBuilder();
2272bbccca9SAdam Balogh   BasicValueFactory &BV = SVB.getBasicValueFactory();
2282bbccca9SAdam Balogh 
2292bbccca9SAdam Balogh   QualType T = Sym->getType();
2302bbccca9SAdam Balogh   assert(T->isSignedIntegerOrEnumerationType() &&
2312bbccca9SAdam Balogh          "This only works with signed integers!");
2322bbccca9SAdam Balogh   APSIntType AT = BV.getAPSIntType(T);
2332bbccca9SAdam Balogh 
2342bbccca9SAdam Balogh   llvm::APSInt Max = AT.getMaxValue() / AT.getValue(4), Min = -Max;
2352bbccca9SAdam Balogh   return isInRelation(BO_LE, Sym, Max, State) &&
2362bbccca9SAdam Balogh          isInRelation(BO_GE, Sym, Min, State);
2372bbccca9SAdam Balogh }
2382bbccca9SAdam Balogh 
2392bbccca9SAdam Balogh // Same for the concrete integers: see if I is within [min/4, max/4].
2402bbccca9SAdam Balogh static bool isWithinConstantOverflowBounds(llvm::APSInt I) {
2412bbccca9SAdam Balogh   APSIntType AT(I);
2422bbccca9SAdam Balogh   assert(!AT.isUnsigned() &&
2432bbccca9SAdam Balogh          "This only works with signed integers!");
2442bbccca9SAdam Balogh 
2452bbccca9SAdam Balogh   llvm::APSInt Max = AT.getMaxValue() / AT.getValue(4), Min = -Max;
2462bbccca9SAdam Balogh   return (I <= Max) && (I >= -Max);
2472bbccca9SAdam Balogh }
2482bbccca9SAdam Balogh 
2492bbccca9SAdam Balogh static std::pair<SymbolRef, llvm::APSInt>
2502bbccca9SAdam Balogh decomposeSymbol(SymbolRef Sym, BasicValueFactory &BV) {
2512bbccca9SAdam Balogh   if (const auto *SymInt = dyn_cast<SymIntExpr>(Sym))
2522bbccca9SAdam Balogh     if (BinaryOperator::isAdditiveOp(SymInt->getOpcode()))
2532bbccca9SAdam Balogh       return std::make_pair(SymInt->getLHS(),
2542bbccca9SAdam Balogh                             (SymInt->getOpcode() == BO_Add) ?
2552bbccca9SAdam Balogh                             (SymInt->getRHS()) :
2562bbccca9SAdam Balogh                             (-SymInt->getRHS()));
2572bbccca9SAdam Balogh 
2582bbccca9SAdam Balogh   // Fail to decompose: "reduce" the problem to the "$x + 0" case.
2592bbccca9SAdam Balogh   return std::make_pair(Sym, BV.getValue(0, Sym->getType()));
2602bbccca9SAdam Balogh }
2612bbccca9SAdam Balogh 
2622bbccca9SAdam Balogh // Simplify "(LSym + LInt) Op (RSym + RInt)" assuming all values are of the
2632bbccca9SAdam Balogh // same signed integral type and no overflows occur (which should be checked
2642bbccca9SAdam Balogh // by the caller).
2652bbccca9SAdam Balogh static NonLoc doRearrangeUnchecked(ProgramStateRef State,
2662bbccca9SAdam Balogh                                    BinaryOperator::Opcode Op,
2672bbccca9SAdam Balogh                                    SymbolRef LSym, llvm::APSInt LInt,
2682bbccca9SAdam Balogh                                    SymbolRef RSym, llvm::APSInt RInt) {
2692bbccca9SAdam Balogh   SValBuilder &SVB = State->getStateManager().getSValBuilder();
2702bbccca9SAdam Balogh   BasicValueFactory &BV = SVB.getBasicValueFactory();
2712bbccca9SAdam Balogh   SymbolManager &SymMgr = SVB.getSymbolManager();
2722bbccca9SAdam Balogh 
2732bbccca9SAdam Balogh   QualType SymTy = LSym->getType();
2742bbccca9SAdam Balogh   assert(SymTy == RSym->getType() &&
2752bbccca9SAdam Balogh          "Symbols are not of the same type!");
2762bbccca9SAdam Balogh   assert(APSIntType(LInt) == BV.getAPSIntType(SymTy) &&
2772bbccca9SAdam Balogh          "Integers are not of the same type as symbols!");
2782bbccca9SAdam Balogh   assert(APSIntType(RInt) == BV.getAPSIntType(SymTy) &&
2792bbccca9SAdam Balogh          "Integers are not of the same type as symbols!");
2802bbccca9SAdam Balogh 
2812bbccca9SAdam Balogh   QualType ResultTy;
2822bbccca9SAdam Balogh   if (BinaryOperator::isComparisonOp(Op))
2832bbccca9SAdam Balogh     ResultTy = SVB.getConditionType();
2842bbccca9SAdam Balogh   else if (BinaryOperator::isAdditiveOp(Op))
2852bbccca9SAdam Balogh     ResultTy = SymTy;
2862bbccca9SAdam Balogh   else
2872bbccca9SAdam Balogh     llvm_unreachable("Operation not suitable for unchecked rearrangement!");
2882bbccca9SAdam Balogh 
2892bbccca9SAdam Balogh   // FIXME: Can we use assume() without getting into an infinite recursion?
2902bbccca9SAdam Balogh   if (LSym == RSym)
2912bbccca9SAdam Balogh     return SVB.evalBinOpNN(State, Op, nonloc::ConcreteInt(LInt),
2922bbccca9SAdam Balogh                            nonloc::ConcreteInt(RInt), ResultTy)
2932bbccca9SAdam Balogh         .castAs<NonLoc>();
2942bbccca9SAdam Balogh 
2952bbccca9SAdam Balogh   SymbolRef ResultSym = nullptr;
2962bbccca9SAdam Balogh   BinaryOperator::Opcode ResultOp;
2972bbccca9SAdam Balogh   llvm::APSInt ResultInt;
2982bbccca9SAdam Balogh   if (BinaryOperator::isComparisonOp(Op)) {
2992bbccca9SAdam Balogh     // Prefer comparing to a non-negative number.
3002bbccca9SAdam Balogh     // FIXME: Maybe it'd be better to have consistency in
3012bbccca9SAdam Balogh     // "$x - $y" vs. "$y - $x" because those are solver's keys.
3022bbccca9SAdam Balogh     if (LInt > RInt) {
3032bbccca9SAdam Balogh       ResultSym = SymMgr.getSymSymExpr(RSym, BO_Sub, LSym, SymTy);
3042bbccca9SAdam Balogh       ResultOp = BinaryOperator::reverseComparisonOp(Op);
3052bbccca9SAdam Balogh       ResultInt = LInt - RInt; // Opposite order!
3062bbccca9SAdam Balogh     } else {
3072bbccca9SAdam Balogh       ResultSym = SymMgr.getSymSymExpr(LSym, BO_Sub, RSym, SymTy);
3082bbccca9SAdam Balogh       ResultOp = Op;
3092bbccca9SAdam Balogh       ResultInt = RInt - LInt; // Opposite order!
3102bbccca9SAdam Balogh     }
3112bbccca9SAdam Balogh   } else {
3122bbccca9SAdam Balogh     ResultSym = SymMgr.getSymSymExpr(LSym, Op, RSym, SymTy);
3132bbccca9SAdam Balogh     ResultInt = (Op == BO_Add) ? (LInt + RInt) : (LInt - RInt);
3142bbccca9SAdam Balogh     ResultOp = BO_Add;
3152bbccca9SAdam Balogh     // Bring back the cosmetic difference.
3162bbccca9SAdam Balogh     if (ResultInt < 0) {
3172bbccca9SAdam Balogh       ResultInt = -ResultInt;
3182bbccca9SAdam Balogh       ResultOp = BO_Sub;
3192bbccca9SAdam Balogh     } else if (ResultInt == 0) {
3202bbccca9SAdam Balogh       // Shortcut: Simplify "$x + 0" to "$x".
3212bbccca9SAdam Balogh       return nonloc::SymbolVal(ResultSym);
3222bbccca9SAdam Balogh     }
3232bbccca9SAdam Balogh   }
3242bbccca9SAdam Balogh   const llvm::APSInt &PersistentResultInt = BV.getValue(ResultInt);
3252bbccca9SAdam Balogh   return nonloc::SymbolVal(
3262bbccca9SAdam Balogh       SymMgr.getSymIntExpr(ResultSym, ResultOp, PersistentResultInt, ResultTy));
3272bbccca9SAdam Balogh }
3282bbccca9SAdam Balogh 
3292bbccca9SAdam Balogh // Rearrange if symbol type matches the result type and if the operator is a
3302bbccca9SAdam Balogh // comparison operator, both symbol and constant must be within constant
3312bbccca9SAdam Balogh // overflow bounds.
3322bbccca9SAdam Balogh static bool shouldRearrange(ProgramStateRef State, BinaryOperator::Opcode Op,
3332bbccca9SAdam Balogh                             SymbolRef Sym, llvm::APSInt Int, QualType Ty) {
3342bbccca9SAdam Balogh   return Sym->getType() == Ty &&
3352bbccca9SAdam Balogh     (!BinaryOperator::isComparisonOp(Op) ||
3362bbccca9SAdam Balogh      (isWithinConstantOverflowBounds(Sym, State) &&
3372bbccca9SAdam Balogh       isWithinConstantOverflowBounds(Int)));
3382bbccca9SAdam Balogh }
3392bbccca9SAdam Balogh 
3402bbccca9SAdam Balogh static Optional<NonLoc> tryRearrange(ProgramStateRef State,
3412bbccca9SAdam Balogh                                      BinaryOperator::Opcode Op, NonLoc Lhs,
3422bbccca9SAdam Balogh                                      NonLoc Rhs, QualType ResultTy) {
3432bbccca9SAdam Balogh   ProgramStateManager &StateMgr = State->getStateManager();
3442bbccca9SAdam Balogh   SValBuilder &SVB = StateMgr.getSValBuilder();
3452bbccca9SAdam Balogh 
3462bbccca9SAdam Balogh   // We expect everything to be of the same type - this type.
3472bbccca9SAdam Balogh   QualType SingleTy;
3482bbccca9SAdam Balogh 
349dcde8accSAdam Balogh   // FIXME: After putting complexity threshold to the symbols we can always
350dcde8accSAdam Balogh   //        rearrange additive operations but rearrange comparisons only if
351dcde8accSAdam Balogh   //        option is set.
352b97a9640SBalazs Benics   if (!SVB.getAnalyzerOptions().ShouldAggressivelySimplifyBinaryOperation)
353dcde8accSAdam Balogh     return None;
354dcde8accSAdam Balogh 
3552bbccca9SAdam Balogh   SymbolRef LSym = Lhs.getAsSymbol();
3562bbccca9SAdam Balogh   if (!LSym)
3572bbccca9SAdam Balogh     return None;
3582bbccca9SAdam Balogh 
359dcde8accSAdam Balogh   if (BinaryOperator::isComparisonOp(Op)) {
3602bbccca9SAdam Balogh     SingleTy = LSym->getType();
3612bbccca9SAdam Balogh     if (ResultTy != SVB.getConditionType())
3622bbccca9SAdam Balogh       return None;
3632bbccca9SAdam Balogh     // Initialize SingleTy later with a symbol's type.
3642bbccca9SAdam Balogh   } else if (BinaryOperator::isAdditiveOp(Op)) {
3652bbccca9SAdam Balogh     SingleTy = ResultTy;
36613e186c0SAdam Balogh     if (LSym->getType() != SingleTy)
36713e186c0SAdam Balogh       return None;
3682bbccca9SAdam Balogh   } else {
3692bbccca9SAdam Balogh     // Don't rearrange other operations.
3702bbccca9SAdam Balogh     return None;
3712bbccca9SAdam Balogh   }
3722bbccca9SAdam Balogh 
3732bbccca9SAdam Balogh   assert(!SingleTy.isNull() && "We should have figured out the type by now!");
3742bbccca9SAdam Balogh 
375471d0864SAdam Balogh   // Rearrange signed symbolic expressions only
376471d0864SAdam Balogh   if (!SingleTy->isSignedIntegerOrEnumerationType())
377471d0864SAdam Balogh     return None;
378471d0864SAdam Balogh 
3792bbccca9SAdam Balogh   SymbolRef RSym = Rhs.getAsSymbol();
3802bbccca9SAdam Balogh   if (!RSym || RSym->getType() != SingleTy)
3812bbccca9SAdam Balogh     return None;
3822bbccca9SAdam Balogh 
3832bbccca9SAdam Balogh   BasicValueFactory &BV = State->getBasicVals();
3842bbccca9SAdam Balogh   llvm::APSInt LInt, RInt;
3852bbccca9SAdam Balogh   std::tie(LSym, LInt) = decomposeSymbol(LSym, BV);
3862bbccca9SAdam Balogh   std::tie(RSym, RInt) = decomposeSymbol(RSym, BV);
3872bbccca9SAdam Balogh   if (!shouldRearrange(State, Op, LSym, LInt, SingleTy) ||
3882bbccca9SAdam Balogh       !shouldRearrange(State, Op, RSym, RInt, SingleTy))
3892bbccca9SAdam Balogh     return None;
3902bbccca9SAdam Balogh 
3912bbccca9SAdam Balogh   // We know that no overflows can occur anymore.
3922bbccca9SAdam Balogh   return doRearrangeUnchecked(State, Op, LSym, LInt, RSym, RInt);
3932bbccca9SAdam Balogh }
3942bbccca9SAdam Balogh 
39549b1e38eSTed Kremenek SVal SimpleSValBuilder::evalBinOpNN(ProgramStateRef state,
396fa0734ecSArgyrios Kyrtzidis                                   BinaryOperator::Opcode op,
397fa0734ecSArgyrios Kyrtzidis                                   NonLoc lhs, NonLoc rhs,
398fa0734ecSArgyrios Kyrtzidis                                   QualType resultTy)  {
399f0e9ca86SAnna Zaks   NonLoc InputLHS = lhs;
400f0e9ca86SAnna Zaks   NonLoc InputRHS = rhs;
401f0e9ca86SAnna Zaks 
40212887a20SGabor Marton   // Constraints may have changed since the creation of a bound SVal. Check if
40312887a20SGabor Marton   // the values can be simplified based on those new constraints.
40412887a20SGabor Marton   SVal simplifiedLhs = simplifySVal(state, lhs);
40512887a20SGabor Marton   SVal simplifiedRhs = simplifySVal(state, rhs);
40612887a20SGabor Marton   if (auto simplifiedLhsAsNonLoc = simplifiedLhs.getAs<NonLoc>())
40712887a20SGabor Marton     lhs = *simplifiedLhsAsNonLoc;
40812887a20SGabor Marton   if (auto simplifiedRhsAsNonLoc = simplifiedRhs.getAs<NonLoc>())
40912887a20SGabor Marton     rhs = *simplifiedRhsAsNonLoc;
41012887a20SGabor Marton 
411fa0734ecSArgyrios Kyrtzidis   // Handle trivial case where left-side and right-side are the same.
412fa0734ecSArgyrios Kyrtzidis   if (lhs == rhs)
413fa0734ecSArgyrios Kyrtzidis     switch (op) {
414fa0734ecSArgyrios Kyrtzidis       default:
415fa0734ecSArgyrios Kyrtzidis         break;
416fa0734ecSArgyrios Kyrtzidis       case BO_EQ:
417fa0734ecSArgyrios Kyrtzidis       case BO_LE:
418fa0734ecSArgyrios Kyrtzidis       case BO_GE:
419fa0734ecSArgyrios Kyrtzidis         return makeTruthVal(true, resultTy);
420fa0734ecSArgyrios Kyrtzidis       case BO_LT:
421fa0734ecSArgyrios Kyrtzidis       case BO_GT:
422fa0734ecSArgyrios Kyrtzidis       case BO_NE:
423fa0734ecSArgyrios Kyrtzidis         return makeTruthVal(false, resultTy);
424fa0734ecSArgyrios Kyrtzidis       case BO_Xor:
425fa0734ecSArgyrios Kyrtzidis       case BO_Sub:
4267523d1a8SJordan Rose         if (resultTy->isIntegralOrEnumerationType())
427fa0734ecSArgyrios Kyrtzidis           return makeIntVal(0, resultTy);
42801ddfa95SDenys Petrov         return evalCast(makeIntVal(0, /*isUnsigned=*/false), resultTy,
42901ddfa95SDenys Petrov                         QualType{});
430fa0734ecSArgyrios Kyrtzidis       case BO_Or:
431fa0734ecSArgyrios Kyrtzidis       case BO_And:
43201ddfa95SDenys Petrov         return evalCast(lhs, resultTy, QualType{});
433fa0734ecSArgyrios Kyrtzidis     }
434fa0734ecSArgyrios Kyrtzidis 
435*40446663SKazu Hirata   while (true) {
436fa0734ecSArgyrios Kyrtzidis     switch (lhs.getSubKind()) {
437fa0734ecSArgyrios Kyrtzidis     default:
438bd3e5dbfSGeorge Karpenkov       return makeSymExprValNN(op, lhs, rhs, resultTy);
43964c01f7bSDevin Coughlin     case nonloc::PointerToMemberKind: {
44064c01f7bSDevin Coughlin       assert(rhs.getSubKind() == nonloc::PointerToMemberKind &&
44164c01f7bSDevin Coughlin              "Both SVals should have pointer-to-member-type");
44264c01f7bSDevin Coughlin       auto LPTM = lhs.castAs<nonloc::PointerToMember>(),
44364c01f7bSDevin Coughlin            RPTM = rhs.castAs<nonloc::PointerToMember>();
44464c01f7bSDevin Coughlin       auto LPTMD = LPTM.getPTMData(), RPTMD = RPTM.getPTMData();
44564c01f7bSDevin Coughlin       switch (op) {
44664c01f7bSDevin Coughlin         case BO_EQ:
44764c01f7bSDevin Coughlin           return makeTruthVal(LPTMD == RPTMD, resultTy);
44864c01f7bSDevin Coughlin         case BO_NE:
44964c01f7bSDevin Coughlin           return makeTruthVal(LPTMD != RPTMD, resultTy);
45064c01f7bSDevin Coughlin         default:
45164c01f7bSDevin Coughlin           return UnknownVal();
45264c01f7bSDevin Coughlin       }
45364c01f7bSDevin Coughlin     }
454fa0734ecSArgyrios Kyrtzidis     case nonloc::LocAsIntegerKind: {
4552fdacbc5SDavid Blaikie       Loc lhsL = lhs.castAs<nonloc::LocAsInteger>().getLoc();
456fa0734ecSArgyrios Kyrtzidis       switch (rhs.getSubKind()) {
457fa0734ecSArgyrios Kyrtzidis         case nonloc::LocAsIntegerKind:
45818d77984SAlexander Shaposhnikov           // FIXME: at the moment the implementation
45918d77984SAlexander Shaposhnikov           // of modeling "pointers as integers" is not complete.
46018d77984SAlexander Shaposhnikov           if (!BinaryOperator::isComparisonOp(op))
46118d77984SAlexander Shaposhnikov             return UnknownVal();
462fa0734ecSArgyrios Kyrtzidis           return evalBinOpLL(state, op, lhsL,
4632fdacbc5SDavid Blaikie                              rhs.castAs<nonloc::LocAsInteger>().getLoc(),
464fa0734ecSArgyrios Kyrtzidis                              resultTy);
465fa0734ecSArgyrios Kyrtzidis         case nonloc::ConcreteIntKind: {
46618d77984SAlexander Shaposhnikov           // FIXME: at the moment the implementation
46718d77984SAlexander Shaposhnikov           // of modeling "pointers as integers" is not complete.
46818d77984SAlexander Shaposhnikov           if (!BinaryOperator::isComparisonOp(op))
46918d77984SAlexander Shaposhnikov             return UnknownVal();
470fa0734ecSArgyrios Kyrtzidis           // Transform the integer into a location and compare.
4717333a9eaSArtem Dergachev           // FIXME: This only makes sense for comparisons. If we want to, say,
4727333a9eaSArtem Dergachev           // add 1 to a LocAsInteger, we'd better unpack the Loc and add to it,
4737333a9eaSArtem Dergachev           // then pack it back into a LocAsInteger.
4742fdacbc5SDavid Blaikie           llvm::APSInt i = rhs.castAs<nonloc::ConcreteInt>().getValue();
47527ed855aSDavid Stenberg           // If the region has a symbolic base, pay attention to the type; it
47627ed855aSDavid Stenberg           // might be coming from a non-default address space. For non-symbolic
47727ed855aSDavid Stenberg           // regions it doesn't matter that much because such comparisons would
47827ed855aSDavid Stenberg           // most likely evaluate to concrete false anyway. FIXME: We might
47927ed855aSDavid Stenberg           // still need to handle the non-comparison case.
48027ed855aSDavid Stenberg           if (SymbolRef lSym = lhs.getAsLocSymbol(true))
48127ed855aSDavid Stenberg             BasicVals.getAPSIntType(lSym->getType()).apply(i);
48227ed855aSDavid Stenberg           else
4837e3c3ea3SJordy Rose             BasicVals.getAPSIntType(Context.VoidPtrTy).apply(i);
484fa0734ecSArgyrios Kyrtzidis           return evalBinOpLL(state, op, lhsL, makeLoc(i), resultTy);
485fa0734ecSArgyrios Kyrtzidis         }
486fa0734ecSArgyrios Kyrtzidis         default:
487fa0734ecSArgyrios Kyrtzidis           switch (op) {
488fa0734ecSArgyrios Kyrtzidis             case BO_EQ:
489fa0734ecSArgyrios Kyrtzidis               return makeTruthVal(false, resultTy);
490fa0734ecSArgyrios Kyrtzidis             case BO_NE:
491fa0734ecSArgyrios Kyrtzidis               return makeTruthVal(true, resultTy);
492fa0734ecSArgyrios Kyrtzidis             default:
493fa0734ecSArgyrios Kyrtzidis               // This case also handles pointer arithmetic.
494bd3e5dbfSGeorge Karpenkov               return makeSymExprValNN(op, InputLHS, InputRHS, resultTy);
495fa0734ecSArgyrios Kyrtzidis           }
496fa0734ecSArgyrios Kyrtzidis       }
497fa0734ecSArgyrios Kyrtzidis     }
498d066f79cSAnna Zaks     case nonloc::ConcreteIntKind: {
4992fdacbc5SDavid Blaikie       llvm::APSInt LHSValue = lhs.castAs<nonloc::ConcreteInt>().getValue();
500d066f79cSAnna Zaks 
50154569448SJordy Rose       // If we're dealing with two known constants, just perform the operation.
50254569448SJordy Rose       if (const llvm::APSInt *KnownRHSValue = getKnownValue(state, rhs)) {
50354569448SJordy Rose         llvm::APSInt RHSValue = *KnownRHSValue;
50454569448SJordy Rose         if (BinaryOperator::isComparisonOp(op)) {
50554569448SJordy Rose           // We're looking for a type big enough to compare the two values.
5067e3c3ea3SJordy Rose           // FIXME: This is not correct. char + short will result in a promotion
5077e3c3ea3SJordy Rose           // to int. Unfortunately we have lost types by this point.
5087e3c3ea3SJordy Rose           APSIntType CompareType = std::max(APSIntType(LHSValue),
5097e3c3ea3SJordy Rose                                             APSIntType(RHSValue));
5107e3c3ea3SJordy Rose           CompareType.apply(LHSValue);
5117e3c3ea3SJordy Rose           CompareType.apply(RHSValue);
51254569448SJordy Rose         } else if (!BinaryOperator::isShiftOp(op)) {
5137e3c3ea3SJordy Rose           APSIntType IntType = BasicVals.getAPSIntType(resultTy);
5147e3c3ea3SJordy Rose           IntType.apply(LHSValue);
5157e3c3ea3SJordy Rose           IntType.apply(RHSValue);
516d066f79cSAnna Zaks         }
517d066f79cSAnna Zaks 
51854569448SJordy Rose         const llvm::APSInt *Result =
51954569448SJordy Rose           BasicVals.evalAPSInt(op, LHSValue, RHSValue);
52054569448SJordy Rose         if (!Result)
52154569448SJordy Rose           return UndefinedVal();
52254569448SJordy Rose 
52354569448SJordy Rose         return nonloc::ConcreteInt(*Result);
52454569448SJordy Rose       }
525d066f79cSAnna Zaks 
526d066f79cSAnna Zaks       // Swap the left and right sides and flip the operator if doing so
527d066f79cSAnna Zaks       // allows us to better reason about the expression (this is a form
528d066f79cSAnna Zaks       // of expression canonicalization).
529d066f79cSAnna Zaks       // While we're at it, catch some special cases for non-commutative ops.
530d066f79cSAnna Zaks       switch (op) {
531d066f79cSAnna Zaks       case BO_LT:
532d066f79cSAnna Zaks       case BO_GT:
533d066f79cSAnna Zaks       case BO_LE:
534d066f79cSAnna Zaks       case BO_GE:
535604d0bbbSJordan Rose         op = BinaryOperator::reverseComparisonOp(op);
5364dc0b1acSReid Kleckner         LLVM_FALLTHROUGH;
537d066f79cSAnna Zaks       case BO_EQ:
538d066f79cSAnna Zaks       case BO_NE:
539d066f79cSAnna Zaks       case BO_Add:
540d066f79cSAnna Zaks       case BO_Mul:
541d066f79cSAnna Zaks       case BO_And:
542d066f79cSAnna Zaks       case BO_Xor:
543d066f79cSAnna Zaks       case BO_Or:
54454569448SJordy Rose         std::swap(lhs, rhs);
545d066f79cSAnna Zaks         continue;
546d066f79cSAnna Zaks       case BO_Shr:
54754569448SJordy Rose         // (~0)>>a
548d933adeaSJay Foad         if (LHSValue.isAllOnes() && LHSValue.isSigned())
54901ddfa95SDenys Petrov           return evalCast(lhs, resultTy, QualType{});
5504dc0b1acSReid Kleckner         LLVM_FALLTHROUGH;
551d066f79cSAnna Zaks       case BO_Shl:
55254569448SJordy Rose         // 0<<a and 0>>a
55354569448SJordy Rose         if (LHSValue == 0)
55401ddfa95SDenys Petrov           return evalCast(lhs, resultTy, QualType{});
555bd3e5dbfSGeorge Karpenkov         return makeSymExprValNN(op, InputLHS, InputRHS, resultTy);
556015c3988SGabor Marton       case BO_Div:
557015c3988SGabor Marton         // 0 / x == 0
55873c120a9SValeriy Savchenko       case BO_Rem:
55973c120a9SValeriy Savchenko         // 0 % x == 0
56073c120a9SValeriy Savchenko         if (LHSValue == 0)
56173c120a9SValeriy Savchenko           return makeZeroVal(resultTy);
56273c120a9SValeriy Savchenko         LLVM_FALLTHROUGH;
563d066f79cSAnna Zaks       default:
564bd3e5dbfSGeorge Karpenkov         return makeSymExprValNN(op, InputLHS, InputRHS, resultTy);
565d066f79cSAnna Zaks       }
566d066f79cSAnna Zaks     }
567d066f79cSAnna Zaks     case nonloc::SymbolValKind: {
56854569448SJordy Rose       // We only handle LHS as simple symbols or SymIntExprs.
5692fdacbc5SDavid Blaikie       SymbolRef Sym = lhs.castAs<nonloc::SymbolVal>().getSymbol();
570d066f79cSAnna Zaks 
571d066f79cSAnna Zaks       // LHS is a symbolic expression.
57254569448SJordy Rose       if (const SymIntExpr *symIntExpr = dyn_cast<SymIntExpr>(Sym)) {
573fa0734ecSArgyrios Kyrtzidis 
574fa0734ecSArgyrios Kyrtzidis         // Is this a logical not? (!x is represented as x == 0.)
575fa0734ecSArgyrios Kyrtzidis         if (op == BO_EQ && rhs.isZeroConstant()) {
576fa0734ecSArgyrios Kyrtzidis           // We know how to negate certain expressions. Simplify them here.
577fa0734ecSArgyrios Kyrtzidis 
578fa0734ecSArgyrios Kyrtzidis           BinaryOperator::Opcode opc = symIntExpr->getOpcode();
579fa0734ecSArgyrios Kyrtzidis           switch (opc) {
580fa0734ecSArgyrios Kyrtzidis           default:
581fa0734ecSArgyrios Kyrtzidis             // We don't know how to negate this operation.
582fa0734ecSArgyrios Kyrtzidis             // Just handle it as if it were a normal comparison to 0.
583fa0734ecSArgyrios Kyrtzidis             break;
584fa0734ecSArgyrios Kyrtzidis           case BO_LAnd:
585fa0734ecSArgyrios Kyrtzidis           case BO_LOr:
58683d382b1SDavid Blaikie             llvm_unreachable("Logical operators handled by branching logic.");
587fa0734ecSArgyrios Kyrtzidis           case BO_Assign:
588fa0734ecSArgyrios Kyrtzidis           case BO_MulAssign:
589fa0734ecSArgyrios Kyrtzidis           case BO_DivAssign:
590fa0734ecSArgyrios Kyrtzidis           case BO_RemAssign:
591fa0734ecSArgyrios Kyrtzidis           case BO_AddAssign:
592fa0734ecSArgyrios Kyrtzidis           case BO_SubAssign:
593fa0734ecSArgyrios Kyrtzidis           case BO_ShlAssign:
594fa0734ecSArgyrios Kyrtzidis           case BO_ShrAssign:
595fa0734ecSArgyrios Kyrtzidis           case BO_AndAssign:
596fa0734ecSArgyrios Kyrtzidis           case BO_XorAssign:
597fa0734ecSArgyrios Kyrtzidis           case BO_OrAssign:
598fa0734ecSArgyrios Kyrtzidis           case BO_Comma:
59983d382b1SDavid Blaikie             llvm_unreachable("'=' and ',' operators handled by ExprEngine.");
600fa0734ecSArgyrios Kyrtzidis           case BO_PtrMemD:
601fa0734ecSArgyrios Kyrtzidis           case BO_PtrMemI:
60283d382b1SDavid Blaikie             llvm_unreachable("Pointer arithmetic not handled here.");
603fa0734ecSArgyrios Kyrtzidis           case BO_LT:
604fa0734ecSArgyrios Kyrtzidis           case BO_GT:
605fa0734ecSArgyrios Kyrtzidis           case BO_LE:
606fa0734ecSArgyrios Kyrtzidis           case BO_GE:
607fa0734ecSArgyrios Kyrtzidis           case BO_EQ:
608fa0734ecSArgyrios Kyrtzidis           case BO_NE:
609dc16628cSJordan Rose             assert(resultTy->isBooleanType() ||
610dc16628cSJordan Rose                    resultTy == getConditionType());
611dc16628cSJordan Rose             assert(symIntExpr->getType()->isBooleanType() ||
612dc16628cSJordan Rose                    getContext().hasSameUnqualifiedType(symIntExpr->getType(),
613dc16628cSJordan Rose                                                        getConditionType()));
614fa0734ecSArgyrios Kyrtzidis             // Negate the comparison and make a value.
615604d0bbbSJordan Rose             opc = BinaryOperator::negateComparisonOp(opc);
616fa0734ecSArgyrios Kyrtzidis             return makeNonLoc(symIntExpr->getLHS(), opc,
617fa0734ecSArgyrios Kyrtzidis                 symIntExpr->getRHS(), resultTy);
618fa0734ecSArgyrios Kyrtzidis           }
619fa0734ecSArgyrios Kyrtzidis         }
620fa0734ecSArgyrios Kyrtzidis 
621fa0734ecSArgyrios Kyrtzidis         // For now, only handle expressions whose RHS is a constant.
62254569448SJordy Rose         if (const llvm::APSInt *RHSValue = getKnownValue(state, rhs)) {
623fa0734ecSArgyrios Kyrtzidis           // If both the LHS and the current expression are additive,
62454569448SJordy Rose           // fold their constants and try again.
625fa0734ecSArgyrios Kyrtzidis           if (BinaryOperator::isAdditiveOp(op)) {
626fa0734ecSArgyrios Kyrtzidis             BinaryOperator::Opcode lop = symIntExpr->getOpcode();
627fa0734ecSArgyrios Kyrtzidis             if (BinaryOperator::isAdditiveOp(lop)) {
62854569448SJordy Rose               // Convert the two constants to a common type, then combine them.
62954569448SJordy Rose 
630fa0734ecSArgyrios Kyrtzidis               // resultTy may not be the best type to convert to, but it's
631fa0734ecSArgyrios Kyrtzidis               // probably the best choice in expressions with mixed type
632fa0734ecSArgyrios Kyrtzidis               // (such as x+1U+2LL). The rules for implicit conversions should
633fa0734ecSArgyrios Kyrtzidis               // choose a reasonable type to preserve the expression, and will
634fa0734ecSArgyrios Kyrtzidis               // at least match how the value is going to be used.
6357e3c3ea3SJordy Rose               APSIntType IntType = BasicVals.getAPSIntType(resultTy);
6367e3c3ea3SJordy Rose               const llvm::APSInt &first = IntType.convert(symIntExpr->getRHS());
6377e3c3ea3SJordy Rose               const llvm::APSInt &second = IntType.convert(*RHSValue);
63854569448SJordy Rose 
639fa0734ecSArgyrios Kyrtzidis               const llvm::APSInt *newRHS;
640fa0734ecSArgyrios Kyrtzidis               if (lop == op)
641fa0734ecSArgyrios Kyrtzidis                 newRHS = BasicVals.evalAPSInt(BO_Add, first, second);
642fa0734ecSArgyrios Kyrtzidis               else
643fa0734ecSArgyrios Kyrtzidis                 newRHS = BasicVals.evalAPSInt(BO_Sub, first, second);
64454569448SJordy Rose 
64554569448SJordy Rose               assert(newRHS && "Invalid operation despite common type!");
64654569448SJordy Rose               rhs = nonloc::ConcreteInt(*newRHS);
64754569448SJordy Rose               lhs = nonloc::SymbolVal(symIntExpr->getLHS());
64854569448SJordy Rose               op = lop;
64954569448SJordy Rose               continue;
650fa0734ecSArgyrios Kyrtzidis             }
651fa0734ecSArgyrios Kyrtzidis           }
652fa0734ecSArgyrios Kyrtzidis 
65354569448SJordy Rose           // Otherwise, make a SymIntExpr out of the expression.
65454569448SJordy Rose           return MakeSymIntVal(symIntExpr, op, *RHSValue, resultTy);
65554569448SJordy Rose         }
6563b4c3ea2SJordan Rose       }
657fa0734ecSArgyrios Kyrtzidis 
65854569448SJordy Rose       // Is the RHS a constant?
65954569448SJordy Rose       if (const llvm::APSInt *RHSValue = getKnownValue(state, rhs))
66054569448SJordy Rose         return MakeSymIntVal(Sym, op, *RHSValue, resultTy);
661fa0734ecSArgyrios Kyrtzidis 
6622bbccca9SAdam Balogh       if (Optional<NonLoc> V = tryRearrange(state, op, lhs, rhs, resultTy))
6632bbccca9SAdam Balogh         return *V;
6642bbccca9SAdam Balogh 
66554569448SJordy Rose       // Give up -- this is not a symbolic expression we can handle.
666bd3e5dbfSGeorge Karpenkov       return makeSymExprValNN(op, InputLHS, InputRHS, resultTy);
667fa0734ecSArgyrios Kyrtzidis     }
668fa0734ecSArgyrios Kyrtzidis     }
669fa0734ecSArgyrios Kyrtzidis   }
670fa0734ecSArgyrios Kyrtzidis }
671fa0734ecSArgyrios Kyrtzidis 
672bac964e1SAnna Zaks static SVal evalBinOpFieldRegionFieldRegion(const FieldRegion *LeftFR,
673bac964e1SAnna Zaks                                             const FieldRegion *RightFR,
674bac964e1SAnna Zaks                                             BinaryOperator::Opcode op,
675bac964e1SAnna Zaks                                             QualType resultTy,
676bac964e1SAnna Zaks                                             SimpleSValBuilder &SVB) {
677bac964e1SAnna Zaks   // Only comparisons are meaningful here!
678bac964e1SAnna Zaks   if (!BinaryOperator::isComparisonOp(op))
679bac964e1SAnna Zaks     return UnknownVal();
680bac964e1SAnna Zaks 
681bac964e1SAnna Zaks   // Next, see if the two FRs have the same super-region.
682bac964e1SAnna Zaks   // FIXME: This doesn't handle casts yet, and simply stripping the casts
683bac964e1SAnna Zaks   // doesn't help.
684bac964e1SAnna Zaks   if (LeftFR->getSuperRegion() != RightFR->getSuperRegion())
685bac964e1SAnna Zaks     return UnknownVal();
686bac964e1SAnna Zaks 
687bac964e1SAnna Zaks   const FieldDecl *LeftFD = LeftFR->getDecl();
688bac964e1SAnna Zaks   const FieldDecl *RightFD = RightFR->getDecl();
689bac964e1SAnna Zaks   const RecordDecl *RD = LeftFD->getParent();
690bac964e1SAnna Zaks 
691bac964e1SAnna Zaks   // Make sure the two FRs are from the same kind of record. Just in case!
692bac964e1SAnna Zaks   // FIXME: This is probably where inheritance would be a problem.
693bac964e1SAnna Zaks   if (RD != RightFD->getParent())
694bac964e1SAnna Zaks     return UnknownVal();
695bac964e1SAnna Zaks 
696bac964e1SAnna Zaks   // We know for sure that the two fields are not the same, since that
697bac964e1SAnna Zaks   // would have given us the same SVal.
698bac964e1SAnna Zaks   if (op == BO_EQ)
699bac964e1SAnna Zaks     return SVB.makeTruthVal(false, resultTy);
700bac964e1SAnna Zaks   if (op == BO_NE)
701bac964e1SAnna Zaks     return SVB.makeTruthVal(true, resultTy);
702bac964e1SAnna Zaks 
703bac964e1SAnna Zaks   // Iterate through the fields and see which one comes first.
704bac964e1SAnna Zaks   // [C99 6.7.2.1.13] "Within a structure object, the non-bit-field
705bac964e1SAnna Zaks   // members and the units in which bit-fields reside have addresses that
706bac964e1SAnna Zaks   // increase in the order in which they are declared."
707bac964e1SAnna Zaks   bool leftFirst = (op == BO_LT || op == BO_LE);
708e8a8baefSAaron Ballman   for (const auto *I : RD->fields()) {
709e8a8baefSAaron Ballman     if (I == LeftFD)
710bac964e1SAnna Zaks       return SVB.makeTruthVal(leftFirst, resultTy);
711e8a8baefSAaron Ballman     if (I == RightFD)
712bac964e1SAnna Zaks       return SVB.makeTruthVal(!leftFirst, resultTy);
713bac964e1SAnna Zaks   }
714bac964e1SAnna Zaks 
715bac964e1SAnna Zaks   llvm_unreachable("Fields not found in parent record's definition");
716bac964e1SAnna Zaks }
717bac964e1SAnna Zaks 
718fa0734ecSArgyrios Kyrtzidis // FIXME: all this logic will change if/when we have MemRegion::getLocation().
71949b1e38eSTed Kremenek SVal SimpleSValBuilder::evalBinOpLL(ProgramStateRef state,
720fa0734ecSArgyrios Kyrtzidis                                   BinaryOperator::Opcode op,
721fa0734ecSArgyrios Kyrtzidis                                   Loc lhs, Loc rhs,
722fa0734ecSArgyrios Kyrtzidis                                   QualType resultTy) {
723fa0734ecSArgyrios Kyrtzidis   // Only comparisons and subtractions are valid operations on two pointers.
724fa0734ecSArgyrios Kyrtzidis   // See [C99 6.5.5 through 6.5.14] or [C++0x 5.6 through 5.15].
725fa0734ecSArgyrios Kyrtzidis   // However, if a pointer is casted to an integer, evalBinOpNN may end up
726fa0734ecSArgyrios Kyrtzidis   // calling this function with another operation (PR7527). We don't attempt to
727fa0734ecSArgyrios Kyrtzidis   // model this for now, but it could be useful, particularly when the
728fa0734ecSArgyrios Kyrtzidis   // "location" is actually an integer value that's been passed through a void*.
729fa0734ecSArgyrios Kyrtzidis   if (!(BinaryOperator::isComparisonOp(op) || op == BO_Sub))
730fa0734ecSArgyrios Kyrtzidis     return UnknownVal();
731fa0734ecSArgyrios Kyrtzidis 
732fa0734ecSArgyrios Kyrtzidis   // Special cases for when both sides are identical.
733fa0734ecSArgyrios Kyrtzidis   if (lhs == rhs) {
734fa0734ecSArgyrios Kyrtzidis     switch (op) {
735fa0734ecSArgyrios Kyrtzidis     default:
73683d382b1SDavid Blaikie       llvm_unreachable("Unimplemented operation for two identical values");
737fa0734ecSArgyrios Kyrtzidis     case BO_Sub:
738fa0734ecSArgyrios Kyrtzidis       return makeZeroVal(resultTy);
739fa0734ecSArgyrios Kyrtzidis     case BO_EQ:
740fa0734ecSArgyrios Kyrtzidis     case BO_LE:
741fa0734ecSArgyrios Kyrtzidis     case BO_GE:
742fa0734ecSArgyrios Kyrtzidis       return makeTruthVal(true, resultTy);
743fa0734ecSArgyrios Kyrtzidis     case BO_NE:
744fa0734ecSArgyrios Kyrtzidis     case BO_LT:
745fa0734ecSArgyrios Kyrtzidis     case BO_GT:
746fa0734ecSArgyrios Kyrtzidis       return makeTruthVal(false, resultTy);
747fa0734ecSArgyrios Kyrtzidis     }
748fa0734ecSArgyrios Kyrtzidis   }
749fa0734ecSArgyrios Kyrtzidis 
750fa0734ecSArgyrios Kyrtzidis   switch (lhs.getSubKind()) {
751fa0734ecSArgyrios Kyrtzidis   default:
75283d382b1SDavid Blaikie     llvm_unreachable("Ordering not implemented for this Loc.");
753fa0734ecSArgyrios Kyrtzidis 
754fa0734ecSArgyrios Kyrtzidis   case loc::GotoLabelKind:
755fa0734ecSArgyrios Kyrtzidis     // The only thing we know about labels is that they're non-null.
756fa0734ecSArgyrios Kyrtzidis     if (rhs.isZeroConstant()) {
757fa0734ecSArgyrios Kyrtzidis       switch (op) {
758fa0734ecSArgyrios Kyrtzidis       default:
759fa0734ecSArgyrios Kyrtzidis         break;
760fa0734ecSArgyrios Kyrtzidis       case BO_Sub:
76101ddfa95SDenys Petrov         return evalCast(lhs, resultTy, QualType{});
762fa0734ecSArgyrios Kyrtzidis       case BO_EQ:
763fa0734ecSArgyrios Kyrtzidis       case BO_LE:
764fa0734ecSArgyrios Kyrtzidis       case BO_LT:
765fa0734ecSArgyrios Kyrtzidis         return makeTruthVal(false, resultTy);
766fa0734ecSArgyrios Kyrtzidis       case BO_NE:
767fa0734ecSArgyrios Kyrtzidis       case BO_GT:
768fa0734ecSArgyrios Kyrtzidis       case BO_GE:
769fa0734ecSArgyrios Kyrtzidis         return makeTruthVal(true, resultTy);
770fa0734ecSArgyrios Kyrtzidis       }
771fa0734ecSArgyrios Kyrtzidis     }
772fa0734ecSArgyrios Kyrtzidis     // There may be two labels for the same location, and a function region may
773fa0734ecSArgyrios Kyrtzidis     // have the same address as a label at the start of the function (depending
774fa0734ecSArgyrios Kyrtzidis     // on the ABI).
775fa0734ecSArgyrios Kyrtzidis     // FIXME: we can probably do a comparison against other MemRegions, though.
776fa0734ecSArgyrios Kyrtzidis     // FIXME: is there a way to tell if two labels refer to the same location?
777fa0734ecSArgyrios Kyrtzidis     return UnknownVal();
778fa0734ecSArgyrios Kyrtzidis 
779fa0734ecSArgyrios Kyrtzidis   case loc::ConcreteIntKind: {
780fa0734ecSArgyrios Kyrtzidis     // If one of the operands is a symbol and the other is a constant,
781fa0734ecSArgyrios Kyrtzidis     // build an expression for use by the constraint manager.
782fa0734ecSArgyrios Kyrtzidis     if (SymbolRef rSym = rhs.getAsLocSymbol()) {
783c0402c69SDominic Chen       // We can only build expressions with symbols on the left,
784c0402c69SDominic Chen       // so we need a reversible operator.
785c70f1d63SRichard Smith       if (!BinaryOperator::isComparisonOp(op) || op == BO_Cmp)
786c0402c69SDominic Chen         return UnknownVal();
78735610d21SDominic Chen 
788c0402c69SDominic Chen       const llvm::APSInt &lVal = lhs.castAs<loc::ConcreteInt>().getValue();
789604d0bbbSJordan Rose       op = BinaryOperator::reverseComparisonOp(op);
790604d0bbbSJordan Rose       return makeNonLoc(rSym, op, lVal, resultTy);
791fa0734ecSArgyrios Kyrtzidis     }
792fa0734ecSArgyrios Kyrtzidis 
793fa0734ecSArgyrios Kyrtzidis     // If both operands are constants, just perform the operation.
79405785d16SDavid Blaikie     if (Optional<loc::ConcreteInt> rInt = rhs.getAs<loc::ConcreteInt>()) {
7952fdacbc5SDavid Blaikie       SVal ResultVal =
7962fdacbc5SDavid Blaikie           lhs.castAs<loc::ConcreteInt>().evalBinOp(BasicVals, op, *rInt);
7978eca04b2SJordan Rose       if (Optional<NonLoc> Result = ResultVal.getAs<NonLoc>())
79801ddfa95SDenys Petrov         return evalCast(*Result, resultTy, QualType{});
7998eca04b2SJordan Rose 
8008eca04b2SJordan Rose       assert(!ResultVal.getAs<Loc>() && "Loc-Loc ops should not produce Locs");
801fa0734ecSArgyrios Kyrtzidis       return UnknownVal();
802fa0734ecSArgyrios Kyrtzidis     }
803fa0734ecSArgyrios Kyrtzidis 
804fa0734ecSArgyrios Kyrtzidis     // Special case comparisons against NULL.
805fa0734ecSArgyrios Kyrtzidis     // This must come after the test if the RHS is a symbol, which is used to
806fa0734ecSArgyrios Kyrtzidis     // build constraints. The address of any non-symbolic region is guaranteed
807fa0734ecSArgyrios Kyrtzidis     // to be non-NULL, as is any label.
8082fdacbc5SDavid Blaikie     assert(rhs.getAs<loc::MemRegionVal>() || rhs.getAs<loc::GotoLabel>());
809fa0734ecSArgyrios Kyrtzidis     if (lhs.isZeroConstant()) {
810fa0734ecSArgyrios Kyrtzidis       switch (op) {
811fa0734ecSArgyrios Kyrtzidis       default:
812fa0734ecSArgyrios Kyrtzidis         break;
813fa0734ecSArgyrios Kyrtzidis       case BO_EQ:
814fa0734ecSArgyrios Kyrtzidis       case BO_GT:
815fa0734ecSArgyrios Kyrtzidis       case BO_GE:
816fa0734ecSArgyrios Kyrtzidis         return makeTruthVal(false, resultTy);
817fa0734ecSArgyrios Kyrtzidis       case BO_NE:
818fa0734ecSArgyrios Kyrtzidis       case BO_LT:
819fa0734ecSArgyrios Kyrtzidis       case BO_LE:
820fa0734ecSArgyrios Kyrtzidis         return makeTruthVal(true, resultTy);
821fa0734ecSArgyrios Kyrtzidis       }
822fa0734ecSArgyrios Kyrtzidis     }
823fa0734ecSArgyrios Kyrtzidis 
824fa0734ecSArgyrios Kyrtzidis     // Comparing an arbitrary integer to a region or label address is
825fa0734ecSArgyrios Kyrtzidis     // completely unknowable.
826fa0734ecSArgyrios Kyrtzidis     return UnknownVal();
827fa0734ecSArgyrios Kyrtzidis   }
82873f018e3SArtem Dergachev   case loc::MemRegionValKind: {
82905785d16SDavid Blaikie     if (Optional<loc::ConcreteInt> rInt = rhs.getAs<loc::ConcreteInt>()) {
830fa0734ecSArgyrios Kyrtzidis       // If one of the operands is a symbol and the other is a constant,
831fa0734ecSArgyrios Kyrtzidis       // build an expression for use by the constraint manager.
832f4963ff1SAlexander Shaposhnikov       if (SymbolRef lSym = lhs.getAsLocSymbol(true)) {
833f4963ff1SAlexander Shaposhnikov         if (BinaryOperator::isComparisonOp(op))
834fa0734ecSArgyrios Kyrtzidis           return MakeSymIntVal(lSym, op, rInt->getValue(), resultTy);
835f4963ff1SAlexander Shaposhnikov         return UnknownVal();
836f4963ff1SAlexander Shaposhnikov       }
837fa0734ecSArgyrios Kyrtzidis       // Special case comparisons to NULL.
838fa0734ecSArgyrios Kyrtzidis       // This must come after the test if the LHS is a symbol, which is used to
839fa0734ecSArgyrios Kyrtzidis       // build constraints. The address of any non-symbolic region is guaranteed
840fa0734ecSArgyrios Kyrtzidis       // to be non-NULL.
841fa0734ecSArgyrios Kyrtzidis       if (rInt->isZeroConstant()) {
842acd080b9SJordan Rose         if (op == BO_Sub)
84301ddfa95SDenys Petrov           return evalCast(lhs, resultTy, QualType{});
844acd080b9SJordan Rose 
845acd080b9SJordan Rose         if (BinaryOperator::isComparisonOp(op)) {
846acd080b9SJordan Rose           QualType boolType = getContext().BoolTy;
84701ddfa95SDenys Petrov           NonLoc l = evalCast(lhs, boolType, QualType{}).castAs<NonLoc>();
848acd080b9SJordan Rose           NonLoc r = makeTruthVal(false, boolType).castAs<NonLoc>();
849acd080b9SJordan Rose           return evalBinOpNN(state, op, l, r, resultTy);
850fa0734ecSArgyrios Kyrtzidis         }
851fa0734ecSArgyrios Kyrtzidis       }
852fa0734ecSArgyrios Kyrtzidis 
853fa0734ecSArgyrios Kyrtzidis       // Comparing a region to an arbitrary integer is completely unknowable.
854fa0734ecSArgyrios Kyrtzidis       return UnknownVal();
855fa0734ecSArgyrios Kyrtzidis     }
856fa0734ecSArgyrios Kyrtzidis 
857fa0734ecSArgyrios Kyrtzidis     // Get both values as regions, if possible.
858fa0734ecSArgyrios Kyrtzidis     const MemRegion *LeftMR = lhs.getAsRegion();
85973f018e3SArtem Dergachev     assert(LeftMR && "MemRegionValKind SVal doesn't have a region!");
860fa0734ecSArgyrios Kyrtzidis 
861fa0734ecSArgyrios Kyrtzidis     const MemRegion *RightMR = rhs.getAsRegion();
862fa0734ecSArgyrios Kyrtzidis     if (!RightMR)
863fa0734ecSArgyrios Kyrtzidis       // The RHS is probably a label, which in theory could address a region.
864fa0734ecSArgyrios Kyrtzidis       // FIXME: we can probably make a more useful statement about non-code
865fa0734ecSArgyrios Kyrtzidis       // regions, though.
866fa0734ecSArgyrios Kyrtzidis       return UnknownVal();
867fa0734ecSArgyrios Kyrtzidis 
868fa0734ecSArgyrios Kyrtzidis     const MemRegion *LeftBase = LeftMR->getBaseRegion();
869fa0734ecSArgyrios Kyrtzidis     const MemRegion *RightBase = RightMR->getBaseRegion();
8703b4c3ea2SJordan Rose     const MemSpaceRegion *LeftMS = LeftBase->getMemorySpace();
8713b4c3ea2SJordan Rose     const MemSpaceRegion *RightMS = RightBase->getMemorySpace();
8723b4c3ea2SJordan Rose     const MemSpaceRegion *UnknownMS = MemMgr.getUnknownRegion();
8733563fde6SAnna Zaks 
8743563fde6SAnna Zaks     // If the two regions are from different known memory spaces they cannot be
8753563fde6SAnna Zaks     // equal. Also, assume that no symbolic region (whose memory space is
8763563fde6SAnna Zaks     // unknown) is on the stack.
8773563fde6SAnna Zaks     if (LeftMS != RightMS &&
8783563fde6SAnna Zaks         ((LeftMS != UnknownMS && RightMS != UnknownMS) ||
8793563fde6SAnna Zaks          (isa<StackSpaceRegion>(LeftMS) || isa<StackSpaceRegion>(RightMS)))) {
880fa0734ecSArgyrios Kyrtzidis       switch (op) {
881fa0734ecSArgyrios Kyrtzidis       default:
882fa0734ecSArgyrios Kyrtzidis         return UnknownVal();
883fa0734ecSArgyrios Kyrtzidis       case BO_EQ:
884fa0734ecSArgyrios Kyrtzidis         return makeTruthVal(false, resultTy);
885fa0734ecSArgyrios Kyrtzidis       case BO_NE:
886fa0734ecSArgyrios Kyrtzidis         return makeTruthVal(true, resultTy);
887fa0734ecSArgyrios Kyrtzidis       }
888fa0734ecSArgyrios Kyrtzidis     }
889fa0734ecSArgyrios Kyrtzidis 
8903563fde6SAnna Zaks     // If both values wrap regions, see if they're from different base regions.
8913563fde6SAnna Zaks     // Note, heap base symbolic regions are assumed to not alias with
8923563fde6SAnna Zaks     // each other; for example, we assume that malloc returns different address
8933563fde6SAnna Zaks     // on each invocation.
894aacc03c9SArtem Dergachev     // FIXME: ObjC object pointers always reside on the heap, but currently
895aacc03c9SArtem Dergachev     // we treat their memory space as unknown, because symbolic pointers
896aacc03c9SArtem Dergachev     // to ObjC objects may alias. There should be a way to construct
897aacc03c9SArtem Dergachev     // possibly-aliasing heap-based regions. For instance, MacOSXApiChecker
898aacc03c9SArtem Dergachev     // guesses memory space for ObjC object pointers manually instead of
899aacc03c9SArtem Dergachev     // relying on us.
9003563fde6SAnna Zaks     if (LeftBase != RightBase &&
9013563fde6SAnna Zaks         ((!isa<SymbolicRegion>(LeftBase) && !isa<SymbolicRegion>(RightBase)) ||
902a7dcc996SAnna Zaks          (isa<HeapSpaceRegion>(LeftMS) || isa<HeapSpaceRegion>(RightMS))) ){
9039d96f843STed Kremenek       switch (op) {
9049d96f843STed Kremenek       default:
9053563fde6SAnna Zaks         return UnknownVal();
9069d96f843STed Kremenek       case BO_EQ:
9079d96f843STed Kremenek         return makeTruthVal(false, resultTy);
9089d96f843STed Kremenek       case BO_NE:
9099d96f843STed Kremenek         return makeTruthVal(true, resultTy);
9109d96f843STed Kremenek       }
9119d96f843STed Kremenek     }
912fa0734ecSArgyrios Kyrtzidis 
913bac964e1SAnna Zaks     // Handle special cases for when both regions are element regions.
914fa0734ecSArgyrios Kyrtzidis     const ElementRegion *RightER = dyn_cast<ElementRegion>(RightMR);
915bac964e1SAnna Zaks     const ElementRegion *LeftER = dyn_cast<ElementRegion>(LeftMR);
916bac964e1SAnna Zaks     if (RightER && LeftER) {
917fa0734ecSArgyrios Kyrtzidis       // Next, see if the two ERs have the same super-region and matching types.
918fa0734ecSArgyrios Kyrtzidis       // FIXME: This should do something useful even if the types don't match,
919fa0734ecSArgyrios Kyrtzidis       // though if both indexes are constant the RegionRawOffset path will
920fa0734ecSArgyrios Kyrtzidis       // give the correct answer.
921fa0734ecSArgyrios Kyrtzidis       if (LeftER->getSuperRegion() == RightER->getSuperRegion() &&
922fa0734ecSArgyrios Kyrtzidis           LeftER->getElementType() == RightER->getElementType()) {
923fa0734ecSArgyrios Kyrtzidis         // Get the left index and cast it to the correct type.
924fa0734ecSArgyrios Kyrtzidis         // If the index is unknown or undefined, bail out here.
925fa0734ecSArgyrios Kyrtzidis         SVal LeftIndexVal = LeftER->getIndex();
92605785d16SDavid Blaikie         Optional<NonLoc> LeftIndex = LeftIndexVal.getAs<NonLoc>();
927fa0734ecSArgyrios Kyrtzidis         if (!LeftIndex)
928fa0734ecSArgyrios Kyrtzidis           return UnknownVal();
92901ddfa95SDenys Petrov         LeftIndexVal = evalCast(*LeftIndex, ArrayIndexTy, QualType{});
9302fdacbc5SDavid Blaikie         LeftIndex = LeftIndexVal.getAs<NonLoc>();
931fa0734ecSArgyrios Kyrtzidis         if (!LeftIndex)
932fa0734ecSArgyrios Kyrtzidis           return UnknownVal();
933fa0734ecSArgyrios Kyrtzidis 
934fa0734ecSArgyrios Kyrtzidis         // Do the same for the right index.
935fa0734ecSArgyrios Kyrtzidis         SVal RightIndexVal = RightER->getIndex();
93605785d16SDavid Blaikie         Optional<NonLoc> RightIndex = RightIndexVal.getAs<NonLoc>();
937fa0734ecSArgyrios Kyrtzidis         if (!RightIndex)
938fa0734ecSArgyrios Kyrtzidis           return UnknownVal();
93901ddfa95SDenys Petrov         RightIndexVal = evalCast(*RightIndex, ArrayIndexTy, QualType{});
9402fdacbc5SDavid Blaikie         RightIndex = RightIndexVal.getAs<NonLoc>();
941fa0734ecSArgyrios Kyrtzidis         if (!RightIndex)
942fa0734ecSArgyrios Kyrtzidis           return UnknownVal();
943fa0734ecSArgyrios Kyrtzidis 
944fa0734ecSArgyrios Kyrtzidis         // Actually perform the operation.
945fa0734ecSArgyrios Kyrtzidis         // evalBinOpNN expects the two indexes to already be the right type.
946fa0734ecSArgyrios Kyrtzidis         return evalBinOpNN(state, op, *LeftIndex, *RightIndex, resultTy);
947fa0734ecSArgyrios Kyrtzidis       }
948bac964e1SAnna Zaks     }
949fa0734ecSArgyrios Kyrtzidis 
950bac964e1SAnna Zaks     // Special handling of the FieldRegions, even with symbolic offsets.
951bac964e1SAnna Zaks     const FieldRegion *RightFR = dyn_cast<FieldRegion>(RightMR);
952bac964e1SAnna Zaks     const FieldRegion *LeftFR = dyn_cast<FieldRegion>(LeftMR);
953bac964e1SAnna Zaks     if (RightFR && LeftFR) {
954bac964e1SAnna Zaks       SVal R = evalBinOpFieldRegionFieldRegion(LeftFR, RightFR, op, resultTy,
955bac964e1SAnna Zaks                                                *this);
956bac964e1SAnna Zaks       if (!R.isUnknown())
957bac964e1SAnna Zaks         return R;
958bac964e1SAnna Zaks     }
959bac964e1SAnna Zaks 
960bac964e1SAnna Zaks     // Compare the regions using the raw offsets.
961bac964e1SAnna Zaks     RegionOffset LeftOffset = LeftMR->getAsOffset();
962bac964e1SAnna Zaks     RegionOffset RightOffset = RightMR->getAsOffset();
963fa0734ecSArgyrios Kyrtzidis 
9640dbb783cSCraig Topper     if (LeftOffset.getRegion() != nullptr &&
965bac964e1SAnna Zaks         LeftOffset.getRegion() == RightOffset.getRegion() &&
966bac964e1SAnna Zaks         !LeftOffset.hasSymbolicOffset() && !RightOffset.hasSymbolicOffset()) {
967bac964e1SAnna Zaks       int64_t left = LeftOffset.getOffset();
968bac964e1SAnna Zaks       int64_t right = RightOffset.getOffset();
969fa0734ecSArgyrios Kyrtzidis 
970fa0734ecSArgyrios Kyrtzidis       switch (op) {
971fa0734ecSArgyrios Kyrtzidis         default:
972fa0734ecSArgyrios Kyrtzidis           return UnknownVal();
973fa0734ecSArgyrios Kyrtzidis         case BO_LT:
974fa0734ecSArgyrios Kyrtzidis           return makeTruthVal(left < right, resultTy);
975fa0734ecSArgyrios Kyrtzidis         case BO_GT:
976fa0734ecSArgyrios Kyrtzidis           return makeTruthVal(left > right, resultTy);
977fa0734ecSArgyrios Kyrtzidis         case BO_LE:
978fa0734ecSArgyrios Kyrtzidis           return makeTruthVal(left <= right, resultTy);
979fa0734ecSArgyrios Kyrtzidis         case BO_GE:
980fa0734ecSArgyrios Kyrtzidis           return makeTruthVal(left >= right, resultTy);
981fa0734ecSArgyrios Kyrtzidis         case BO_EQ:
982fa0734ecSArgyrios Kyrtzidis           return makeTruthVal(left == right, resultTy);
983fa0734ecSArgyrios Kyrtzidis         case BO_NE:
984fa0734ecSArgyrios Kyrtzidis           return makeTruthVal(left != right, resultTy);
985fa0734ecSArgyrios Kyrtzidis       }
986fa0734ecSArgyrios Kyrtzidis     }
987fa0734ecSArgyrios Kyrtzidis 
9883b4c3ea2SJordan Rose     // At this point we're not going to get a good answer, but we can try
9893b4c3ea2SJordan Rose     // conjuring an expression instead.
9903b4c3ea2SJordan Rose     SymbolRef LHSSym = lhs.getAsLocSymbol();
9913b4c3ea2SJordan Rose     SymbolRef RHSSym = rhs.getAsLocSymbol();
9923b4c3ea2SJordan Rose     if (LHSSym && RHSSym)
9933b4c3ea2SJordan Rose       return makeNonLoc(LHSSym, op, RHSSym, resultTy);
9943b4c3ea2SJordan Rose 
995fa0734ecSArgyrios Kyrtzidis     // If we get here, we have no way of comparing the regions.
996fa0734ecSArgyrios Kyrtzidis     return UnknownVal();
997fa0734ecSArgyrios Kyrtzidis   }
998fa0734ecSArgyrios Kyrtzidis   }
999fa0734ecSArgyrios Kyrtzidis }
1000fa0734ecSArgyrios Kyrtzidis 
100149b1e38eSTed Kremenek SVal SimpleSValBuilder::evalBinOpLN(ProgramStateRef state,
10029cbfdde2SValeriy Savchenko                                     BinaryOperator::Opcode op, Loc lhs,
10039cbfdde2SValeriy Savchenko                                     NonLoc rhs, QualType resultTy) {
100464c01f7bSDevin Coughlin   if (op >= BO_PtrMemD && op <= BO_PtrMemI) {
100564c01f7bSDevin Coughlin     if (auto PTMSV = rhs.getAs<nonloc::PointerToMember>()) {
100664c01f7bSDevin Coughlin       if (PTMSV->isNullMemberPointer())
100764c01f7bSDevin Coughlin         return UndefinedVal();
10089cbfdde2SValeriy Savchenko 
10099cbfdde2SValeriy Savchenko       auto getFieldLValue = [&](const auto *FD) -> SVal {
101064c01f7bSDevin Coughlin         SVal Result = lhs;
101164c01f7bSDevin Coughlin 
101264c01f7bSDevin Coughlin         for (const auto &I : *PTMSV)
101364c01f7bSDevin Coughlin           Result = StateMgr.getStoreManager().evalDerivedToBase(
101464c01f7bSDevin Coughlin               Result, I->getType(), I->isVirtual());
10159cbfdde2SValeriy Savchenko 
101664c01f7bSDevin Coughlin         return state->getLValue(FD, Result);
10179cbfdde2SValeriy Savchenko       };
10189cbfdde2SValeriy Savchenko 
10199cbfdde2SValeriy Savchenko       if (const auto *FD = PTMSV->getDeclAs<FieldDecl>()) {
10209cbfdde2SValeriy Savchenko         return getFieldLValue(FD);
10219cbfdde2SValeriy Savchenko       }
10229cbfdde2SValeriy Savchenko       if (const auto *FD = PTMSV->getDeclAs<IndirectFieldDecl>()) {
10239cbfdde2SValeriy Savchenko         return getFieldLValue(FD);
102464c01f7bSDevin Coughlin       }
102564c01f7bSDevin Coughlin     }
102664c01f7bSDevin Coughlin 
102764c01f7bSDevin Coughlin     return rhs;
102864c01f7bSDevin Coughlin   }
102964c01f7bSDevin Coughlin 
1030686df322SJordan Rose   assert(!BinaryOperator::isComparisonOp(op) &&
1031686df322SJordan Rose          "arguments to comparison ops must be of the same type");
1032fa0734ecSArgyrios Kyrtzidis 
1033fa0734ecSArgyrios Kyrtzidis   // Special case: rhs is a zero constant.
1034fa0734ecSArgyrios Kyrtzidis   if (rhs.isZeroConstant())
1035fa0734ecSArgyrios Kyrtzidis     return lhs;
1036fa0734ecSArgyrios Kyrtzidis 
103721524676SGabor Horvath   // Perserve the null pointer so that it can be found by the DerefChecker.
103821524676SGabor Horvath   if (lhs.isZeroConstant())
103921524676SGabor Horvath     return lhs;
104021524676SGabor Horvath 
1041fa0734ecSArgyrios Kyrtzidis   // We are dealing with pointer arithmetic.
1042fa0734ecSArgyrios Kyrtzidis 
1043fa0734ecSArgyrios Kyrtzidis   // Handle pointer arithmetic on constant values.
104405785d16SDavid Blaikie   if (Optional<nonloc::ConcreteInt> rhsInt = rhs.getAs<nonloc::ConcreteInt>()) {
104505785d16SDavid Blaikie     if (Optional<loc::ConcreteInt> lhsInt = lhs.getAs<loc::ConcreteInt>()) {
1046fa0734ecSArgyrios Kyrtzidis       const llvm::APSInt &leftI = lhsInt->getValue();
1047fa0734ecSArgyrios Kyrtzidis       assert(leftI.isUnsigned());
1048fa0734ecSArgyrios Kyrtzidis       llvm::APSInt rightI(rhsInt->getValue(), /* isUnsigned */ true);
1049fa0734ecSArgyrios Kyrtzidis 
1050fa0734ecSArgyrios Kyrtzidis       // Convert the bitwidth of rightI.  This should deal with overflow
1051fa0734ecSArgyrios Kyrtzidis       // since we are dealing with concrete values.
1052fa0734ecSArgyrios Kyrtzidis       rightI = rightI.extOrTrunc(leftI.getBitWidth());
1053fa0734ecSArgyrios Kyrtzidis 
1054fa0734ecSArgyrios Kyrtzidis       // Offset the increment by the pointer size.
1055fa0734ecSArgyrios Kyrtzidis       llvm::APSInt Multiplicand(rightI.getBitWidth(), /* isUnsigned */ true);
105621524676SGabor Horvath       QualType pointeeType = resultTy->getPointeeType();
105721524676SGabor Horvath       Multiplicand = getContext().getTypeSizeInChars(pointeeType).getQuantity();
1058fa0734ecSArgyrios Kyrtzidis       rightI *= Multiplicand;
1059fa0734ecSArgyrios Kyrtzidis 
1060fa0734ecSArgyrios Kyrtzidis       // Compute the adjusted pointer.
1061fa0734ecSArgyrios Kyrtzidis       switch (op) {
1062fa0734ecSArgyrios Kyrtzidis         case BO_Add:
1063fa0734ecSArgyrios Kyrtzidis           rightI = leftI + rightI;
1064fa0734ecSArgyrios Kyrtzidis           break;
1065fa0734ecSArgyrios Kyrtzidis         case BO_Sub:
1066fa0734ecSArgyrios Kyrtzidis           rightI = leftI - rightI;
1067fa0734ecSArgyrios Kyrtzidis           break;
1068fa0734ecSArgyrios Kyrtzidis         default:
1069fa0734ecSArgyrios Kyrtzidis           llvm_unreachable("Invalid pointer arithmetic operation");
1070fa0734ecSArgyrios Kyrtzidis       }
1071fa0734ecSArgyrios Kyrtzidis       return loc::ConcreteInt(getBasicValueFactory().getValue(rightI));
1072fa0734ecSArgyrios Kyrtzidis     }
1073fa0734ecSArgyrios Kyrtzidis   }
1074fa0734ecSArgyrios Kyrtzidis 
1075fa0734ecSArgyrios Kyrtzidis   // Handle cases where 'lhs' is a region.
1076fa0734ecSArgyrios Kyrtzidis   if (const MemRegion *region = lhs.getAsRegion()) {
10772fdacbc5SDavid Blaikie     rhs = convertToArrayIndex(rhs).castAs<NonLoc>();
1078fa0734ecSArgyrios Kyrtzidis     SVal index = UnknownVal();
10796dd11048SArtem Dergachev     const SubRegion *superR = nullptr;
10807333a9eaSArtem Dergachev     // We need to know the type of the pointer in order to add an integer to it.
10817333a9eaSArtem Dergachev     // Depending on the type, different amount of bytes is added.
1082fa0734ecSArgyrios Kyrtzidis     QualType elementType;
1083fa0734ecSArgyrios Kyrtzidis 
1084fa0734ecSArgyrios Kyrtzidis     if (const ElementRegion *elemReg = dyn_cast<ElementRegion>(region)) {
108557a4a152STed Kremenek       assert(op == BO_Add || op == BO_Sub);
108657a4a152STed Kremenek       index = evalBinOpNN(state, op, elemReg->getIndex(), rhs,
1087fa0734ecSArgyrios Kyrtzidis                           getArrayIndexType());
10886dd11048SArtem Dergachev       superR = cast<SubRegion>(elemReg->getSuperRegion());
1089fa0734ecSArgyrios Kyrtzidis       elementType = elemReg->getElementType();
1090fa0734ecSArgyrios Kyrtzidis     }
1091fa0734ecSArgyrios Kyrtzidis     else if (isa<SubRegion>(region)) {
1092c4b28a8fSGabor Horvath       assert(op == BO_Add || op == BO_Sub);
1093c4b28a8fSGabor Horvath       index = (op == BO_Add) ? rhs : evalMinus(rhs);
10946dd11048SArtem Dergachev       superR = cast<SubRegion>(region);
10957333a9eaSArtem Dergachev       // TODO: Is this actually reliable? Maybe improving our MemRegion
10967333a9eaSArtem Dergachev       // hierarchy to provide typed regions for all non-void pointers would be
10977333a9eaSArtem Dergachev       // better. For instance, we cannot extend this towards LocAsInteger
10987333a9eaSArtem Dergachev       // operations, where result type of the expression is integer.
1099d1a08b6eSJordan Rose       if (resultTy->isAnyPointerType())
1100d1a08b6eSJordan Rose         elementType = resultTy->getPointeeType();
1101fa0734ecSArgyrios Kyrtzidis     }
1102fa0734ecSArgyrios Kyrtzidis 
1103df1bb8a6SArtem Dergachev     // Represent arithmetic on void pointers as arithmetic on char pointers.
1104df1bb8a6SArtem Dergachev     // It is fine when a TypedValueRegion of char value type represents
1105df1bb8a6SArtem Dergachev     // a void pointer. Note that arithmetic on void pointers is a GCC extension.
1106df1bb8a6SArtem Dergachev     if (elementType->isVoidType())
1107df1bb8a6SArtem Dergachev       elementType = getContext().CharTy;
1108df1bb8a6SArtem Dergachev 
110905785d16SDavid Blaikie     if (Optional<NonLoc> indexV = index.getAs<NonLoc>()) {
1110fa0734ecSArgyrios Kyrtzidis       return loc::MemRegionVal(MemMgr.getElementRegion(elementType, *indexV,
1111fa0734ecSArgyrios Kyrtzidis                                                        superR, getContext()));
1112fa0734ecSArgyrios Kyrtzidis     }
1113fa0734ecSArgyrios Kyrtzidis   }
1114fa0734ecSArgyrios Kyrtzidis   return UnknownVal();
1115fa0734ecSArgyrios Kyrtzidis }
1116fa0734ecSArgyrios Kyrtzidis 
111749b1e38eSTed Kremenek const llvm::APSInt *SimpleSValBuilder::getKnownValue(ProgramStateRef state,
1118fa0734ecSArgyrios Kyrtzidis                                                    SVal V) {
11199ff67a9dSGeorge Karpenkov   V = simplifySVal(state, V);
1120fa0734ecSArgyrios Kyrtzidis   if (V.isUnknownOrUndef())
11210dbb783cSCraig Topper     return nullptr;
1122fa0734ecSArgyrios Kyrtzidis 
112305785d16SDavid Blaikie   if (Optional<loc::ConcreteInt> X = V.getAs<loc::ConcreteInt>())
1124fa0734ecSArgyrios Kyrtzidis     return &X->getValue();
1125fa0734ecSArgyrios Kyrtzidis 
112605785d16SDavid Blaikie   if (Optional<nonloc::ConcreteInt> X = V.getAs<nonloc::ConcreteInt>())
1127fa0734ecSArgyrios Kyrtzidis     return &X->getValue();
1128fa0734ecSArgyrios Kyrtzidis 
1129fa0734ecSArgyrios Kyrtzidis   if (SymbolRef Sym = V.getAsSymbol())
1130244e1d7dSTed Kremenek     return state->getConstraintManager().getSymVal(state, Sym);
1131fa0734ecSArgyrios Kyrtzidis 
11320dbb783cSCraig Topper   return nullptr;
1133fa0734ecSArgyrios Kyrtzidis }
113412294f8dSArtem Dergachev 
1135978431e8SGabor Marton SVal SimpleSValBuilder::simplifyUntilFixpoint(ProgramStateRef State, SVal Val) {
1136978431e8SGabor Marton   SVal SimplifiedVal = simplifySValOnce(State, Val);
1137978431e8SGabor Marton   while (SimplifiedVal != Val) {
1138978431e8SGabor Marton     Val = SimplifiedVal;
1139978431e8SGabor Marton     SimplifiedVal = simplifySValOnce(State, Val);
1140978431e8SGabor Marton   }
1141978431e8SGabor Marton   return SimplifiedVal;
1142978431e8SGabor Marton }
1143978431e8SGabor Marton 
114412294f8dSArtem Dergachev SVal SimpleSValBuilder::simplifySVal(ProgramStateRef State, SVal V) {
1145978431e8SGabor Marton   return simplifyUntilFixpoint(State, V);
1146978431e8SGabor Marton }
1147978431e8SGabor Marton 
1148978431e8SGabor Marton SVal SimpleSValBuilder::simplifySValOnce(ProgramStateRef State, SVal V) {
114912294f8dSArtem Dergachev   // For now, this function tries to constant-fold symbols inside a
115012294f8dSArtem Dergachev   // nonloc::SymbolVal, and does nothing else. More simplifications should
115112294f8dSArtem Dergachev   // be possible, such as constant-folding an index in an ElementRegion.
115212294f8dSArtem Dergachev 
115312294f8dSArtem Dergachev   class Simplifier : public FullSValVisitor<Simplifier, SVal> {
115412294f8dSArtem Dergachev     ProgramStateRef State;
115512294f8dSArtem Dergachev     SValBuilder &SVB;
115612294f8dSArtem Dergachev 
115722746d7dSArtem Dergachev     // Cache results for the lifetime of the Simplifier. Results change every
115822746d7dSArtem Dergachev     // time new constraints are added to the program state, which is the whole
115922746d7dSArtem Dergachev     // point of simplifying, and for that very reason it's pointless to maintain
116022746d7dSArtem Dergachev     // the same cache for the duration of the whole analysis.
116122746d7dSArtem Dergachev     llvm::DenseMap<SymbolRef, SVal> Cached;
116222746d7dSArtem Dergachev 
116316a1f64cSArtem Dergachev     static bool isUnchanged(SymbolRef Sym, SVal Val) {
116416a1f64cSArtem Dergachev       return Sym == Val.getAsSymbol();
116516a1f64cSArtem Dergachev     }
116616a1f64cSArtem Dergachev 
11679fe9a95fSArtem Dergachev     SVal cache(SymbolRef Sym, SVal V) {
11689fe9a95fSArtem Dergachev       Cached[Sym] = V;
11699fe9a95fSArtem Dergachev       return V;
11709fe9a95fSArtem Dergachev     }
11719fe9a95fSArtem Dergachev 
11729fe9a95fSArtem Dergachev     SVal skip(SymbolRef Sym) {
11739fe9a95fSArtem Dergachev       return cache(Sym, SVB.makeSymbolVal(Sym));
11749fe9a95fSArtem Dergachev     }
11759fe9a95fSArtem Dergachev 
11760a17896fSGabor Marton     // Return the known const value for the Sym if available, or return Undef
11770a17896fSGabor Marton     // otherwise.
11780a17896fSGabor Marton     SVal getConst(SymbolRef Sym) {
11790a17896fSGabor Marton       const llvm::APSInt *Const =
11800a17896fSGabor Marton           State->getConstraintManager().getSymVal(State, Sym);
11810a17896fSGabor Marton       if (Const)
11820a17896fSGabor Marton         return Loc::isLocType(Sym->getType()) ? (SVal)SVB.makeIntLocVal(*Const)
11830a17896fSGabor Marton                                               : (SVal)SVB.makeIntVal(*Const);
11840a17896fSGabor Marton       return UndefinedVal();
11850a17896fSGabor Marton     }
11860a17896fSGabor Marton 
11870a17896fSGabor Marton     SVal getConstOrVisit(SymbolRef Sym) {
11880a17896fSGabor Marton       const SVal Ret = getConst(Sym);
11890a17896fSGabor Marton       if (Ret.isUndef())
11900a17896fSGabor Marton         return Visit(Sym);
11910a17896fSGabor Marton       return Ret;
11920a17896fSGabor Marton     }
11930a17896fSGabor Marton 
119412294f8dSArtem Dergachev   public:
119512294f8dSArtem Dergachev     Simplifier(ProgramStateRef State)
119612294f8dSArtem Dergachev         : State(State), SVB(State->getStateManager().getSValBuilder()) {}
119712294f8dSArtem Dergachev 
119812294f8dSArtem Dergachev     SVal VisitSymbolData(const SymbolData *S) {
11999fe9a95fSArtem Dergachev       // No cache here.
120012294f8dSArtem Dergachev       if (const llvm::APSInt *I =
1201d1163790SArtem Dergachev               SVB.getKnownValue(State, SVB.makeSymbolVal(S)))
120212294f8dSArtem Dergachev         return Loc::isLocType(S->getType()) ? (SVal)SVB.makeIntLocVal(*I)
120312294f8dSArtem Dergachev                                             : (SVal)SVB.makeIntVal(*I);
120416a1f64cSArtem Dergachev       return SVB.makeSymbolVal(S);
120512294f8dSArtem Dergachev     }
120612294f8dSArtem Dergachev 
12070a17896fSGabor Marton     // TODO: Support SymbolCast.
120812294f8dSArtem Dergachev 
120912294f8dSArtem Dergachev     SVal VisitSymIntExpr(const SymIntExpr *S) {
121022746d7dSArtem Dergachev       auto I = Cached.find(S);
121122746d7dSArtem Dergachev       if (I != Cached.end())
121222746d7dSArtem Dergachev         return I->second;
121322746d7dSArtem Dergachev 
12140a17896fSGabor Marton       SVal LHS = getConstOrVisit(S->getLHS());
12159fe9a95fSArtem Dergachev       if (isUnchanged(S->getLHS(), LHS))
12169fe9a95fSArtem Dergachev         return skip(S);
12179fe9a95fSArtem Dergachev 
121812294f8dSArtem Dergachev       SVal RHS;
121912294f8dSArtem Dergachev       // By looking at the APSInt in the right-hand side of S, we cannot
122012294f8dSArtem Dergachev       // figure out if it should be treated as a Loc or as a NonLoc.
122112294f8dSArtem Dergachev       // So make our guess by recalling that we cannot multiply pointers
122212294f8dSArtem Dergachev       // or compare a pointer to an integer.
122312294f8dSArtem Dergachev       if (Loc::isLocType(S->getLHS()->getType()) &&
122412294f8dSArtem Dergachev           BinaryOperator::isComparisonOp(S->getOpcode())) {
122512294f8dSArtem Dergachev         // The usual conversion of $sym to &SymRegion{$sym}, as they have
122612294f8dSArtem Dergachev         // the same meaning for Loc-type symbols, but the latter form
122712294f8dSArtem Dergachev         // is preferred in SVal computations for being Loc itself.
122812294f8dSArtem Dergachev         if (SymbolRef Sym = LHS.getAsSymbol()) {
122912294f8dSArtem Dergachev           assert(Loc::isLocType(Sym->getType()));
123012294f8dSArtem Dergachev           LHS = SVB.makeLoc(Sym);
123112294f8dSArtem Dergachev         }
123212294f8dSArtem Dergachev         RHS = SVB.makeIntLocVal(S->getRHS());
123312294f8dSArtem Dergachev       } else {
123412294f8dSArtem Dergachev         RHS = SVB.makeIntVal(S->getRHS());
123512294f8dSArtem Dergachev       }
123622746d7dSArtem Dergachev 
12379fe9a95fSArtem Dergachev       return cache(
12389fe9a95fSArtem Dergachev           S, SVB.evalBinOp(State, S->getOpcode(), LHS, RHS, S->getType()));
123912294f8dSArtem Dergachev     }
124012294f8dSArtem Dergachev 
1241ffc32efdSGabor Marton     SVal VisitIntSymExpr(const IntSymExpr *S) {
1242ffc32efdSGabor Marton       auto I = Cached.find(S);
1243ffc32efdSGabor Marton       if (I != Cached.end())
1244ffc32efdSGabor Marton         return I->second;
1245ffc32efdSGabor Marton 
12460a17896fSGabor Marton       SVal RHS = getConstOrVisit(S->getRHS());
1247ffc32efdSGabor Marton       if (isUnchanged(S->getRHS(), RHS))
1248ffc32efdSGabor Marton         return skip(S);
12490a17896fSGabor Marton 
1250ffc32efdSGabor Marton       SVal LHS = SVB.makeIntVal(S->getLHS());
1251ffc32efdSGabor Marton       return cache(
1252ffc32efdSGabor Marton           S, SVB.evalBinOp(State, S->getOpcode(), LHS, RHS, S->getType()));
1253ffc32efdSGabor Marton     }
1254ffc32efdSGabor Marton 
125512294f8dSArtem Dergachev     SVal VisitSymSymExpr(const SymSymExpr *S) {
125622746d7dSArtem Dergachev       auto I = Cached.find(S);
125722746d7dSArtem Dergachev       if (I != Cached.end())
125822746d7dSArtem Dergachev         return I->second;
125922746d7dSArtem Dergachev 
126005220a90SArtem Dergachev       // For now don't try to simplify mixed Loc/NonLoc expressions
126105220a90SArtem Dergachev       // because they often appear from LocAsInteger operations
126205220a90SArtem Dergachev       // and we don't know how to combine a LocAsInteger
126305220a90SArtem Dergachev       // with a concrete value.
126405220a90SArtem Dergachev       if (Loc::isLocType(S->getLHS()->getType()) !=
12659fe9a95fSArtem Dergachev           Loc::isLocType(S->getRHS()->getType()))
12669fe9a95fSArtem Dergachev         return skip(S);
126705220a90SArtem Dergachev 
12680a17896fSGabor Marton       SVal LHS = getConstOrVisit(S->getLHS());
12690a17896fSGabor Marton       SVal RHS = getConstOrVisit(S->getRHS());
12700a17896fSGabor Marton 
12719fe9a95fSArtem Dergachev       if (isUnchanged(S->getLHS(), LHS) && isUnchanged(S->getRHS(), RHS))
12729fe9a95fSArtem Dergachev         return skip(S);
12739fe9a95fSArtem Dergachev 
12749fe9a95fSArtem Dergachev       return cache(
12759fe9a95fSArtem Dergachev           S, SVB.evalBinOp(State, S->getOpcode(), LHS, RHS, S->getType()));
127612294f8dSArtem Dergachev     }
127712294f8dSArtem Dergachev 
127812294f8dSArtem Dergachev     SVal VisitSymExpr(SymbolRef S) { return nonloc::SymbolVal(S); }
127912294f8dSArtem Dergachev 
128012294f8dSArtem Dergachev     SVal VisitMemRegion(const MemRegion *R) { return loc::MemRegionVal(R); }
128112294f8dSArtem Dergachev 
128212294f8dSArtem Dergachev     SVal VisitNonLocSymbolVal(nonloc::SymbolVal V) {
128312294f8dSArtem Dergachev       // Simplification is much more costly than computing complexity.
128412294f8dSArtem Dergachev       // For high complexity, it may be not worth it.
128512294f8dSArtem Dergachev       return Visit(V.getSymbol());
128612294f8dSArtem Dergachev     }
128712294f8dSArtem Dergachev 
128812294f8dSArtem Dergachev     SVal VisitSVal(SVal V) { return V; }
128912294f8dSArtem Dergachev   };
129012294f8dSArtem Dergachev 
129116a1f64cSArtem Dergachev   // A crude way of preventing this function from calling itself from evalBinOp.
129216a1f64cSArtem Dergachev   static bool isReentering = false;
129316a1f64cSArtem Dergachev   if (isReentering)
129416a1f64cSArtem Dergachev     return V;
129516a1f64cSArtem Dergachev 
129616a1f64cSArtem Dergachev   isReentering = true;
129716a1f64cSArtem Dergachev   SVal SimplifiedV = Simplifier(State).Visit(V);
129816a1f64cSArtem Dergachev   isReentering = false;
129916a1f64cSArtem Dergachev 
130016a1f64cSArtem Dergachev   return SimplifiedV;
130112294f8dSArtem Dergachev }
1302