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
|
/*
This file is part of the clazy static checker.
Copyright (C) 2017 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 "thread-with-slots.h"
#include <vector>
#include "HierarchyUtils.h"
#include "QtUtils.h"
#include "TypeUtils.h"
#include "ClazyContext.h"
#include "AccessSpecifierManager.h"
#include "clang/AST/Decl.h"
#include "clang/AST/DeclCXX.h"
#include "clang/AST/Expr.h"
#include "clang/AST/Stmt.h"
#include "clang/Basic/LLVM.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Casting.h"
namespace clang {
class Decl;
} // namespace clang
using namespace clang;
using namespace std;
static bool hasMutexes(Stmt *body)
{
auto declrefs = clazy::getStatements<DeclRefExpr>(body);
for (auto declref : declrefs) {
ValueDecl *valueDecl = declref->getDecl();
if (CXXRecordDecl *record = TypeUtils::typeAsRecord(valueDecl->getType())) {
if (record->getName() == "QMutex" || record->getName() == "QBasicMutex") {
return true;
}
}
}
return false;
}
ThreadWithSlots::ThreadWithSlots(const std::string &name, ClazyContext *context)
: CheckBase(name, context)
{
context->enableAccessSpecifierManager();
}
void ThreadWithSlots::VisitStmt(clang::Stmt *stmt)
{
// Here we catch slots not marked as slots, we warn when the connect is made
auto callExpr = dyn_cast<CallExpr>(stmt);
if (!callExpr || !m_context->accessSpecifierManager)
return;
FunctionDecl *connectFunc = callExpr->getDirectCallee();
if (!clazy::isConnect(connectFunc))
return;
CXXMethodDecl *slot = clazy::receiverMethodForConnect(callExpr);
if (!slot || !TypeUtils::derivesFrom(slot->getParent(), "QThread"))
return;
if (slot->getParent()->getName() == "QThread") // The slots in QThread are thread safe, we're only worried about derived classes
return;
QtAccessSpecifierType specifierType = m_context->accessSpecifierManager->qtAccessSpecifierType(slot);
if (specifierType == QtAccessSpecifier_Slot || specifierType == QtAccessSpecifier_Signal)
return; // For stuff explicitly marked as slots or signals we use VisitDecl
emitWarning(slot, "Slot " + slot->getQualifiedNameAsString() + " might not run in the expected thread");
}
void ThreadWithSlots::VisitDecl(Decl *decl)
{
// Here we catch slots marked as such, and warn when they are declared
auto method = dyn_cast<CXXMethodDecl>(decl);
if (!method || !m_context->accessSpecifierManager || !method->isThisDeclarationADefinition() || !method->hasBody()
|| !TypeUtils::derivesFrom(method->getParent(), "QThread"))
return;
// The slots in QThread are thread safe, we're only worried about derived classes:
if (method->getParent()->getName() == "QThread")
return;
// We're only interested in slots:
if (m_context->accessSpecifierManager->qtAccessSpecifierType(method) != QtAccessSpecifier_Slot)
return;
// Look for a mutex, or mutex locker, to avoid some false-positives
Stmt *body = method->getBody();
if (hasMutexes(body))
return;
// If we use member mutexes, let's not warn either
bool accessesNonMutexMember = false;
auto memberexprs = clazy::getStatements<MemberExpr>(body);
for (auto memberexpr : memberexprs) {
ValueDecl *valueDecl = memberexpr->getMemberDecl();
if (CXXRecordDecl *record = TypeUtils::typeAsRecord(valueDecl->getType())) {
if (record->getName() == "QMutex" || record->getName() == "QBasicMutex") {
return;
}
}
accessesNonMutexMember = true;
}
if (!accessesNonMutexMember)
return;
emitWarning(method, "Slot " + method->getQualifiedNameAsString() + " might not run in the expected thread");
}
|