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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
/*
This file is part of the clazy static checker.
Copyright (C) 2015 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
Author: Sérgio Martins <sergio.martins@kdab.com>
Copyright (C) 2015 Sergio Martins <smartins@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#include "foreach.h"
#include "ClazyContext.h"
#include "Utils.h"
#include "HierarchyUtils.h"
#include "QtUtils.h"
#include "TypeUtils.h"
#include "PreProcessorVisitor.h"
#include "StringUtils.h"
#include <clang/AST/AST.h>
using namespace clang;
using namespace std;
Foreach::Foreach(const std::string &name, ClazyContext *context)
: CheckBase(name, context, Option_CanIgnoreIncludes)
{
context->enablePreprocessorVisitor();
}
void Foreach::VisitStmt(clang::Stmt *stmt)
{
PreProcessorVisitor *preProcessorVisitor = m_context->preprocessorVisitor;
if (!preProcessorVisitor || preProcessorVisitor->qtVersion() >= 50900) {
// Disabled since 5.9 because the Q_FOREACH internals changed.
// Not worth fixing it because range-loop is recommended
return;
}
auto forStm = dyn_cast<ForStmt>(stmt);
if (forStm) {
m_lastForStmt = forStm;
return;
}
if (!m_lastForStmt)
return;
auto constructExpr = dyn_cast<CXXConstructExpr>(stmt);
if (!constructExpr || constructExpr->getNumArgs() < 1)
return;
CXXConstructorDecl *constructorDecl = constructExpr->getConstructor();
if (!constructorDecl || clazy::name(constructorDecl) != "QForeachContainer")
return;
vector<DeclRefExpr*> declRefExprs;
clazy::getChilds<DeclRefExpr>(constructExpr, declRefExprs);
if (declRefExprs.empty())
return;
// Get the container value declaration
DeclRefExpr *declRefExpr = declRefExprs.front();
auto valueDecl = dyn_cast<ValueDecl>(declRefExpr->getDecl());
if (!valueDecl)
return;
QualType containerQualType = constructExpr->getArg(0)->getType();
const Type *containerType = containerQualType.getTypePtrOrNull();
CXXRecordDecl *const containerRecord = containerType ? containerType->getAsCXXRecordDecl() : nullptr;
if (!containerRecord)
return;
auto rootBaseClass = Utils::rootBaseClass(containerRecord);
StringRef containerClassName = clazy::name(rootBaseClass);
const bool isQtContainer = clazy::isQtIterableClass(containerClassName);
if (containerClassName.empty()) {
emitWarning(getLocStart(stmt), "internal error, couldn't get class name of foreach container, please report a bug");
return;
} else {
if (!isQtContainer) {
emitWarning(getLocStart(stmt), "foreach with STL container causes deep-copy (" + rootBaseClass->getQualifiedNameAsString() + ')');
return;
} else if (containerClassName == "QVarLengthArray") {
emitWarning(getLocStart(stmt), "foreach with QVarLengthArray causes deep-copy");
return;
}
}
checkBigTypeMissingRef();
if (isa<MaterializeTemporaryExpr>(constructExpr->getArg(0))) // Nothing else to check
return;
// const containers are fine
if (valueDecl->getType().isConstQualified())
return;
// Now look inside the for statement for detachments
if (containsDetachments(m_lastForStmt, valueDecl)) {
emitWarning(getLocStart(stmt), "foreach container detached");
}
}
void Foreach::checkBigTypeMissingRef()
{
// Get the inner forstm
vector<ForStmt*> forStatements;
clazy::getChilds<ForStmt>(m_lastForStmt->getBody(), forStatements);
if (forStatements.empty())
return;
// Get the variable declaration (lhs of foreach)
vector<DeclStmt*> varDecls;
clazy::getChilds<DeclStmt>(forStatements.at(0), varDecls);
if (varDecls.empty())
return;
Decl *decl = varDecls.at(0)->getSingleDecl();
VarDecl *varDecl = decl ? dyn_cast<VarDecl>(decl) : nullptr;
if (!varDecl)
return;
TypeUtils::QualTypeClassification classif;
bool success = TypeUtils::classifyQualType(m_context, varDecl, /*by-ref*/classif, forStatements.at(0));
if (!success)
return;
if (classif.passBigTypeByConstRef || classif.passNonTriviallyCopyableByConstRef || classif.passSmallTrivialByValue) {
string error;
const string paramStr = varDecl->getType().getAsString();
if (classif.passBigTypeByConstRef) {
error = "Missing reference in foreach with sizeof(T) = ";
error += std::to_string(classif.size_of_T) + " bytes (" + paramStr + ')';
} else if (classif.passNonTriviallyCopyableByConstRef) {
error = "Missing reference in foreach with non trivial type (" + paramStr + ')';
} else if (classif.passSmallTrivialByValue) {
//error = "Pass small and trivially-copyable type by value (" + paramStr + ')';
// Don't warn. The compiler can (and most do) optimize this and generate the same code
return;
}
emitWarning(getLocStart(varDecl), error.c_str());
}
}
bool Foreach::containsDetachments(Stmt *stm, clang::ValueDecl *containerValueDecl)
{
if (!stm)
return false;
auto memberExpr = dyn_cast<MemberExpr>(stm);
if (memberExpr) {
ValueDecl *valDecl = memberExpr->getMemberDecl();
if (valDecl && valDecl->isCXXClassMember()) {
DeclContext *declContext = valDecl->getDeclContext();
auto recordDecl = dyn_cast<CXXRecordDecl>(declContext);
if (recordDecl) {
const std::string className = Utils::rootBaseClass(recordDecl)->getQualifiedNameAsString();
const std::unordered_map<string, std::vector<StringRef> > &detachingMethodsMap = clazy::detachingMethods();
if (detachingMethodsMap.find(className) != detachingMethodsMap.end()) {
const std::string functionName = valDecl->getNameAsString();
const auto &allowedFunctions = detachingMethodsMap.at(className);
if (clazy::contains(allowedFunctions, functionName)) {
Expr *expr = memberExpr->getBase();
if (expr) {
DeclRefExpr *refExpr = dyn_cast<DeclRefExpr>(expr);
if (!refExpr) {
auto s = clazy::getFirstChildAtDepth(expr, 1);
refExpr = dyn_cast<DeclRefExpr>(s);
if (refExpr) {
if (refExpr->getDecl() == containerValueDecl) { // Finally, check if this non-const member call is on the same container we're iterating
return true;
}
}
}
}
}
}
}
}
}
return clazy::any_of(stm->children(), [this, containerValueDecl](Stmt *child) {
return this->containsDetachments(child, containerValueDecl);
});
}
|
