blob: 47b33045416a619e70aae6c08fdaac6a89ed298e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
//==- NonnullStringConstantsChecker.cpp ---------------------------*- C++ -*--//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This checker adds an assumption that constant string-like globals are
// non-null, as otherwise they generally do not convey any useful information.
// The assumption is useful, as many framework use such global const strings,
// and the analyzer might not be able to infer the global value if the
// definition is in a separate translation unit.
// The following types (and their typedef aliases) are considered string-like:
// - `char* const`
// - `const CFStringRef` from CoreFoundation
// - `NSString* const` from Foundation
//
//===----------------------------------------------------------------------===//
#include "ClangSACheckers.h"
#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h"
#include "clang/StaticAnalyzer/Core/Checker.h"
#include "clang/StaticAnalyzer/Core/CheckerManager.h"
#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h"
#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h"
using namespace clang;
using namespace ento;
namespace {
class NonnullStringConstantsChecker : public Checker<check::Location> {
mutable IdentifierInfo *NSStringII = nullptr;
mutable IdentifierInfo *CFStringRefII = nullptr;
public:
NonnullStringConstantsChecker() {}
void checkLocation(SVal l, bool isLoad, const Stmt *S,
CheckerContext &C) const;
private:
void initIdentifierInfo(ASTContext &Ctx) const;
bool isGlobalConstString(SVal V) const;
bool isStringlike(QualType Ty) const;
};
} // namespace
/// Lazily initialize cache for required identifier informations.
void NonnullStringConstantsChecker::initIdentifierInfo(ASTContext &Ctx) const {
if (NSStringII)
return;
NSStringII = &Ctx.Idents.get("NSString");
CFStringRefII = &Ctx.Idents.get("CFStringRef");
}
/// Add an assumption that const string-like globals are non-null.
void NonnullStringConstantsChecker::checkLocation(SVal location, bool isLoad,
const Stmt *S,
CheckerContext &C) const {
initIdentifierInfo(C.getASTContext());
if (!isLoad || !location.isValid())
return;
ProgramStateRef State = C.getState();
SVal V = State->getSVal(location.castAs<Loc>());
if (isGlobalConstString(location)) {
Optional<DefinedOrUnknownSVal> Constr = V.getAs<DefinedOrUnknownSVal>();
if (Constr) {
// Assume that the variable is non-null.
ProgramStateRef OutputState = State->assume(*Constr, true);
C.addTransition(OutputState);
}
}
}
/// \param V loaded lvalue.
/// \return whether {@code val} is a string-like const global.
bool NonnullStringConstantsChecker::isGlobalConstString(SVal V) const {
Optional<loc::MemRegionVal> RegionVal = V.getAs<loc::MemRegionVal>();
if (!RegionVal)
return false;
auto *Region = dyn_cast<VarRegion>(RegionVal->getAsRegion());
if (!Region)
return false;
const VarDecl *Decl = Region->getDecl();
if (!Decl->hasGlobalStorage())
return false;
QualType Ty = Decl->getType();
bool HasConst = Ty.isConstQualified();
if (isStringlike(Ty) && HasConst)
return true;
// Look through the typedefs.
while (auto *T = dyn_cast<TypedefType>(Ty)) {
Ty = T->getDecl()->getUnderlyingType();
// It is sufficient for any intermediate typedef
// to be classified const.
HasConst = HasConst || Ty.isConstQualified();
if (isStringlike(Ty) && HasConst)
return true;
}
return false;
}
/// \return whether {@code type} is a string-like type.
bool NonnullStringConstantsChecker::isStringlike(QualType Ty) const {
if (Ty->isPointerType() && Ty->getPointeeType()->isCharType())
return true;
if (auto *T = dyn_cast<ObjCObjectPointerType>(Ty)) {
return T->getInterfaceDecl()->getIdentifier() == NSStringII;
} else if (auto *T = dyn_cast<TypedefType>(Ty)) {
return T->getDecl()->getIdentifier() == CFStringRefII;
}
return false;
}
void ento::registerNonnullStringConstantsChecker(CheckerManager &Mgr) {
Mgr.registerChecker<NonnullStringConstantsChecker>();
}
|
