1 //=== BuiltinFunctionChecker.cpp --------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This checker evaluates clang builtin functions.
12 //===----------------------------------------------------------------------===//
14 #include "ClangSACheckers.h"
15 #include "clang/Basic/Builtins.h"
16 #include "clang/StaticAnalyzer/Core/Checker.h"
17 #include "clang/StaticAnalyzer/Core/CheckerManager.h"
18 #include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h"
20 using namespace clang;
25 class BuiltinFunctionChecker : public Checker<eval::Call> {
27 bool evalCall(const CallExpr *CE, CheckerContext &C) const;
32 bool BuiltinFunctionChecker::evalCall(const CallExpr *CE,
33 CheckerContext &C) const {
34 ProgramStateRef state = C.getState();
35 const FunctionDecl *FD = C.getCalleeDecl(CE);
36 const LocationContext *LCtx = C.getLocationContext();
40 switch (FD->getBuiltinID()) {
44 case Builtin::BI__builtin_assume: {
45 assert (CE->arg_begin() != CE->arg_end());
46 SVal ArgSVal = C.getSVal(CE->getArg(0));
47 if (ArgSVal.isUndef())
48 return true; // Return true to model purity.
50 state = state->assume(ArgSVal.castAs<DefinedOrUnknownSVal>(), true);
51 // FIXME: do we want to warn here? Not right now. The most reports might
52 // come from infeasible paths, thus being false positives.
54 C.generateSink(C.getState(), C.getPredecessor());
58 C.addTransition(state);
62 case Builtin::BI__builtin_unpredictable:
63 case Builtin::BI__builtin_expect:
64 case Builtin::BI__builtin_assume_aligned:
65 case Builtin::BI__builtin_addressof: {
66 // For __builtin_unpredictable, __builtin_expect, and
67 // __builtin_assume_aligned, just return the value of the subexpression.
68 // __builtin_addressof is going from a reference to a pointer, but those
69 // are represented the same way in the analyzer.
70 assert (CE->arg_begin() != CE->arg_end());
71 SVal X = C.getSVal(*(CE->arg_begin()));
72 C.addTransition(state->BindExpr(CE, LCtx, X));
76 case Builtin::BI__builtin_alloca_with_align:
77 case Builtin::BI__builtin_alloca: {
78 // FIXME: Refactor into StoreManager itself?
79 MemRegionManager& RM = C.getStoreManager().getRegionManager();
80 const AllocaRegion* R =
81 RM.getAllocaRegion(CE, C.blockCount(), C.getLocationContext());
83 // Set the extent of the region in bytes. This enables us to use the
84 // SVal of the argument directly. If we save the extent in bits, we
85 // cannot represent values like symbol*8.
86 auto Size = C.getSVal(*(CE->arg_begin())).castAs<DefinedOrUnknownSVal>();
88 SValBuilder& svalBuilder = C.getSValBuilder();
89 DefinedOrUnknownSVal Extent = R->getExtent(svalBuilder);
90 DefinedOrUnknownSVal extentMatchesSizeArg =
91 svalBuilder.evalEQ(state, Extent, Size);
92 state = state->assume(extentMatchesSizeArg, true);
93 assert(state && "The region should not have any previous constraints");
95 C.addTransition(state->BindExpr(CE, LCtx, loc::MemRegionVal(R)));
99 case Builtin::BI__builtin_object_size:
100 case Builtin::BI__builtin_constant_p: {
101 // This must be resolvable at compile time, so we defer to the constant
102 // evaluator for a value.
103 SVal V = UnknownVal();
105 if (CE->EvaluateAsInt(Result, C.getASTContext(), Expr::SE_NoSideEffects)) {
106 // Make sure the result has the correct type.
107 SValBuilder &SVB = C.getSValBuilder();
108 BasicValueFactory &BVF = SVB.getBasicValueFactory();
109 BVF.getAPSIntType(CE->getType()).apply(Result);
110 V = SVB.makeIntVal(Result);
113 C.addTransition(state->BindExpr(CE, LCtx, V));
119 void ento::registerBuiltinFunctionChecker(CheckerManager &mgr) {
120 mgr.registerChecker<BuiltinFunctionChecker>();