SimpleConstraintManager.h revision 360660
1//== SimpleConstraintManager.h ----------------------------------*- C++ -*--==//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9//  Simplified constraint manager backend.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_SIMPLECONSTRAINTMANAGER_H
14#define LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_SIMPLECONSTRAINTMANAGER_H
15
16#include "clang/StaticAnalyzer/Core/PathSensitive/ConstraintManager.h"
17#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h"
18
19namespace clang {
20
21namespace ento {
22
23class SimpleConstraintManager : public ConstraintManager {
24  SubEngine *SU;
25  SValBuilder &SVB;
26
27public:
28  SimpleConstraintManager(SubEngine *subengine, SValBuilder &SB)
29      : SU(subengine), SVB(SB) {}
30
31  ~SimpleConstraintManager() override;
32
33  //===------------------------------------------------------------------===//
34  // Implementation for interface from ConstraintManager.
35  //===------------------------------------------------------------------===//
36
37  /// Ensures that the DefinedSVal conditional is expressed as a NonLoc by
38  /// creating boolean casts to handle Loc's.
39  ProgramStateRef assume(ProgramStateRef State, DefinedSVal Cond,
40                         bool Assumption) override;
41
42  ProgramStateRef assumeInclusiveRange(ProgramStateRef State, NonLoc Value,
43                                       const llvm::APSInt &From,
44                                       const llvm::APSInt &To,
45                                       bool InRange) override;
46
47protected:
48  //===------------------------------------------------------------------===//
49  // Interface that subclasses must implement.
50  //===------------------------------------------------------------------===//
51
52  /// Given a symbolic expression that can be reasoned about, assume that it is
53  /// true/false and generate the new program state.
54  virtual ProgramStateRef assumeSym(ProgramStateRef State, SymbolRef Sym,
55                                    bool Assumption) = 0;
56
57  /// Given a symbolic expression within the range [From, To], assume that it is
58  /// true/false and generate the new program state.
59  /// This function is used to handle case ranges produced by a language
60  /// extension for switch case statements.
61  virtual ProgramStateRef assumeSymInclusiveRange(ProgramStateRef State,
62                                                  SymbolRef Sym,
63                                                  const llvm::APSInt &From,
64                                                  const llvm::APSInt &To,
65                                                  bool InRange) = 0;
66
67  /// Given a symbolic expression that cannot be reasoned about, assume that
68  /// it is zero/nonzero and add it directly to the solver state.
69  virtual ProgramStateRef assumeSymUnsupported(ProgramStateRef State,
70                                               SymbolRef Sym,
71                                               bool Assumption) = 0;
72
73  //===------------------------------------------------------------------===//
74  // Internal implementation.
75  //===------------------------------------------------------------------===//
76
77  SValBuilder &getSValBuilder() const { return SVB; }
78  BasicValueFactory &getBasicVals() const { return SVB.getBasicValueFactory(); }
79  SymbolManager &getSymbolManager() const { return SVB.getSymbolManager(); }
80
81private:
82  ProgramStateRef assume(ProgramStateRef State, NonLoc Cond, bool Assumption);
83
84  ProgramStateRef assumeAux(ProgramStateRef State, NonLoc Cond,
85                            bool Assumption);
86};
87
88} // end namespace ento
89
90} // end namespace clang
91
92#endif
93