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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#if !defined _WIN32 //TODO, #include <sys/file.h>
#include <cassert>
#include <string>
#include <iostream>
#include <fstream>
#include <unordered_set>
#include <vector>
#include <algorithm>
#include <optional>
#include <sys/file.h>
#include <unistd.h>
#include "config_clang.h"
#include "plugin.hxx"
#include "check.hxx"
#include "compat.hxx"
#include "clang/AST/ParentMapContext.h"
/**
Look for fields that are
(a) only assigned to in the constructor using field-init, and can therefore be const.
(b) protected via a mutex guard when accessed
Which normally means we can remove the mutex guard.
The process goes something like this:
$ make check
$ make FORCE_COMPILE=all COMPILER_PLUGIN_TOOL='locking2' check
$ ./compilerplugins/clang/locking2.py
*/
namespace
{
struct MyFieldInfo
{
std::string parentClass;
std::string fieldName;
std::string fieldType;
std::string sourceLocation;
};
bool operator<(const MyFieldInfo& lhs, const MyFieldInfo& rhs)
{
return std::tie(lhs.parentClass, lhs.fieldName) < std::tie(rhs.parentClass, rhs.fieldName);
}
struct MyLockedInfo
{
const MemberExpr* memberExpr;
std::string parentClass;
std::string fieldName;
std::string sourceLocation;
};
bool operator<(const MyLockedInfo& lhs, const MyLockedInfo& rhs)
{
return std::tie(lhs.parentClass, lhs.fieldName, lhs.sourceLocation)
< std::tie(rhs.parentClass, rhs.fieldName, rhs.sourceLocation);
}
// try to limit the voluminous output a little
static std::set<MyFieldInfo> cannotBeConstSet;
static std::set<MyFieldInfo> definitionSet;
static std::set<MyLockedInfo> lockedAtSet;
/**
* Wrap the different kinds of callable and callee objects in the clang AST so I can define methods that handle everything.
*/
class CallerWrapper
{
const CallExpr* m_callExpr;
const CXXConstructExpr* m_cxxConstructExpr;
public:
CallerWrapper(const CallExpr* callExpr)
: m_callExpr(callExpr)
, m_cxxConstructExpr(nullptr)
{
}
CallerWrapper(const CXXConstructExpr* cxxConstructExpr)
: m_callExpr(nullptr)
, m_cxxConstructExpr(cxxConstructExpr)
{
}
unsigned getNumArgs() const
{
return m_callExpr ? m_callExpr->getNumArgs() : m_cxxConstructExpr->getNumArgs();
}
const Expr* getArg(unsigned i) const
{
return m_callExpr ? m_callExpr->getArg(i) : m_cxxConstructExpr->getArg(i);
}
};
class CalleeWrapper
{
const FunctionDecl* m_calleeFunctionDecl = nullptr;
const CXXConstructorDecl* m_cxxConstructorDecl = nullptr;
const FunctionProtoType* m_functionPrototype = nullptr;
public:
explicit CalleeWrapper(const FunctionDecl* calleeFunctionDecl)
: m_calleeFunctionDecl(calleeFunctionDecl)
{
}
explicit CalleeWrapper(const CXXConstructExpr* cxxConstructExpr)
: m_cxxConstructorDecl(cxxConstructExpr->getConstructor())
{
}
explicit CalleeWrapper(const FunctionProtoType* functionPrototype)
: m_functionPrototype(functionPrototype)
{
}
unsigned getNumParams() const
{
if (m_calleeFunctionDecl)
return m_calleeFunctionDecl->getNumParams();
else if (m_cxxConstructorDecl)
return m_cxxConstructorDecl->getNumParams();
else if (m_functionPrototype->param_type_begin() == m_functionPrototype->param_type_end())
// FunctionProtoType will assert if we call getParamTypes() and it has no params
return 0;
else
return m_functionPrototype->getParamTypes().size();
}
const QualType getParamType(unsigned i) const
{
if (m_calleeFunctionDecl)
return m_calleeFunctionDecl->getParamDecl(i)->getType();
else if (m_cxxConstructorDecl)
return m_cxxConstructorDecl->getParamDecl(i)->getType();
else
return m_functionPrototype->getParamTypes()[i];
}
std::string getNameAsString() const
{
if (m_calleeFunctionDecl)
return m_calleeFunctionDecl->getNameAsString();
else if (m_cxxConstructorDecl)
return m_cxxConstructorDecl->getNameAsString();
else
return "";
}
CXXMethodDecl const* getAsCXXMethodDecl() const
{
if (m_calleeFunctionDecl)
return dyn_cast<CXXMethodDecl>(m_calleeFunctionDecl);
return nullptr;
}
};
class Locking2 : public RecursiveASTVisitor<Locking2>, public loplugin::Plugin
{
public:
explicit Locking2(loplugin::InstantiationData const& data)
: Plugin(data)
{
}
virtual void run() override;
bool shouldVisitTemplateInstantiations() const { return true; }
bool shouldVisitImplicitCode() const { return true; }
bool VisitFieldDecl(const FieldDecl*);
bool VisitMemberExpr(const MemberExpr*);
bool TraverseCXXConstructorDecl(CXXConstructorDecl*);
bool TraverseCXXMethodDecl(CXXMethodDecl*);
bool TraverseFunctionDecl(FunctionDecl*);
bool TraverseIfStmt(IfStmt*);
bool VisitCompoundStmt(const CompoundStmt*);
private:
MyFieldInfo niceName(const FieldDecl*);
MyLockedInfo niceNameLocked(const MemberExpr*);
void check(const FieldDecl* fieldDecl, const Expr* memberExpr);
bool isSomeKindOfZero(const Expr* arg);
bool IsPassedByNonConst(const FieldDecl* fieldDecl, const Stmt* child, CallerWrapper callExpr,
CalleeWrapper calleeFunctionDecl);
compat::optional<CalleeWrapper> getCallee(CallExpr const*);
RecordDecl* insideMoveOrCopyDeclParent = nullptr;
// For reasons I do not understand, parentFunctionDecl() is not reliable, so
// we store the parent function on the way down the AST.
FunctionDecl* insideFunctionDecl = nullptr;
std::vector<FieldDecl const*> insideConditionalCheckOfMemberSet;
bool isSolarMutexLockGuardStmt(const Stmt*);
const CXXThisExpr* isOtherMutexLockGuardStmt(const Stmt*);
};
void Locking2::run()
{
TraverseDecl(compiler.getASTContext().getTranslationUnitDecl());
// dump all our output in one write call - this is to try and limit IO "crosstalk" between multiple processes
// writing to the same logfile
if (!isUnitTestMode())
{
std::string output;
for (const MyFieldInfo& s : cannotBeConstSet)
output += "write-outside-constructor:\t" + s.parentClass + "\t" + s.fieldName + "\n";
for (const MyFieldInfo& s : definitionSet)
output += "definition:\t" + s.parentClass + "\t" + s.fieldName + "\t" + s.fieldType
+ "\t" + s.sourceLocation + "\n";
for (const MyLockedInfo& s : lockedAtSet)
output += "locked:\t" + s.parentClass + "\t" + s.fieldName + "\t" + s.sourceLocation
+ "\n";
std::ofstream myfile;
myfile.open(WORKDIR "/loplugin.locking2.log", std::ios::app | std::ios::out);
myfile << output;
myfile.close();
}
else
{
for (const MyLockedInfo& s : lockedAtSet)
report(DiagnosticsEngine::Warning, "locked %0", s.memberExpr->getBeginLoc())
<< s.fieldName;
}
}
MyFieldInfo Locking2::niceName(const FieldDecl* fieldDecl)
{
MyFieldInfo aInfo;
const RecordDecl* recordDecl = fieldDecl->getParent();
if (const CXXRecordDecl* cxxRecordDecl = dyn_cast<CXXRecordDecl>(recordDecl))
{
if (cxxRecordDecl->getTemplateInstantiationPattern())
cxxRecordDecl = cxxRecordDecl->getTemplateInstantiationPattern();
aInfo.parentClass = cxxRecordDecl->getQualifiedNameAsString();
}
else
{
aInfo.parentClass = recordDecl->getQualifiedNameAsString();
}
aInfo.fieldName = fieldDecl->getNameAsString();
// sometimes the name (if it's an anonymous thing) contains the full path of the build folder, which we don't need
size_t idx = aInfo.fieldName.find(SRCDIR);
if (idx != std::string::npos)
{
aInfo.fieldName = aInfo.fieldName.replace(idx, strlen(SRCDIR), "");
}
aInfo.fieldType = fieldDecl->getType().getAsString();
SourceLocation expansionLoc
= compiler.getSourceManager().getExpansionLoc(fieldDecl->getLocation());
StringRef name = getFilenameOfLocation(expansionLoc);
aInfo.sourceLocation
= std::string(name.substr(strlen(SRCDIR) + 1)) + ":"
+ std::to_string(compiler.getSourceManager().getSpellingLineNumber(expansionLoc));
loplugin::normalizeDotDotInFilePath(aInfo.sourceLocation);
return aInfo;
}
MyLockedInfo Locking2::niceNameLocked(const MemberExpr* memberExpr)
{
MyLockedInfo aInfo;
const FieldDecl* fieldDecl = dyn_cast<FieldDecl>(memberExpr->getMemberDecl());
const RecordDecl* recordDecl = fieldDecl->getParent();
if (const CXXRecordDecl* cxxRecordDecl = dyn_cast<CXXRecordDecl>(recordDecl))
{
if (cxxRecordDecl->getTemplateInstantiationPattern())
cxxRecordDecl = cxxRecordDecl->getTemplateInstantiationPattern();
aInfo.parentClass = cxxRecordDecl->getQualifiedNameAsString();
}
else
{
aInfo.parentClass = recordDecl->getQualifiedNameAsString();
}
aInfo.memberExpr = memberExpr;
aInfo.fieldName = fieldDecl->getNameAsString();
// sometimes the name (if it's an anonymous thing) contains the full path of the build folder, which we don't need
size_t idx = aInfo.fieldName.find(SRCDIR);
if (idx != std::string::npos)
{
aInfo.fieldName = aInfo.fieldName.replace(idx, strlen(SRCDIR), "");
}
SourceLocation expansionLoc
= compiler.getSourceManager().getExpansionLoc(memberExpr->getBeginLoc());
StringRef name = getFilenameOfLocation(expansionLoc);
aInfo.sourceLocation
= std::string(name.substr(strlen(SRCDIR) + 1)) + ":"
+ std::to_string(compiler.getSourceManager().getSpellingLineNumber(expansionLoc));
loplugin::normalizeDotDotInFilePath(aInfo.sourceLocation);
return aInfo;
}
bool Locking2::VisitFieldDecl(const FieldDecl* fieldDecl)
{
fieldDecl = fieldDecl->getCanonicalDecl();
if (ignoreLocation(fieldDecl))
{
return true;
}
// ignore stuff that forms part of the stable URE interface
if (isInUnoIncludeFile(compiler.getSourceManager().getSpellingLoc(fieldDecl->getLocation())))
{
return true;
}
definitionSet.insert(niceName(fieldDecl));
return true;
}
bool Locking2::TraverseCXXConstructorDecl(CXXConstructorDecl* cxxConstructorDecl)
{
auto copy = insideMoveOrCopyDeclParent;
if (!ignoreLocation(cxxConstructorDecl) && cxxConstructorDecl->isThisDeclarationADefinition())
{
if (cxxConstructorDecl->isCopyOrMoveConstructor())
insideMoveOrCopyDeclParent = cxxConstructorDecl->getParent();
}
bool ret = RecursiveASTVisitor::TraverseCXXConstructorDecl(cxxConstructorDecl);
insideMoveOrCopyDeclParent = copy;
return ret;
}
bool Locking2::TraverseCXXMethodDecl(CXXMethodDecl* cxxMethodDecl)
{
auto copy1 = insideMoveOrCopyDeclParent;
auto copy2 = insideFunctionDecl;
if (!ignoreLocation(cxxMethodDecl) && cxxMethodDecl->isThisDeclarationADefinition())
{
if (cxxMethodDecl->isCopyAssignmentOperator() || cxxMethodDecl->isMoveAssignmentOperator())
insideMoveOrCopyDeclParent = cxxMethodDecl->getParent();
}
insideFunctionDecl = cxxMethodDecl;
bool ret = RecursiveASTVisitor::TraverseCXXMethodDecl(cxxMethodDecl);
insideMoveOrCopyDeclParent = copy1;
insideFunctionDecl = copy2;
return ret;
}
bool Locking2::TraverseFunctionDecl(FunctionDecl* functionDecl)
{
auto copy2 = insideFunctionDecl;
insideFunctionDecl = functionDecl;
bool ret = RecursiveASTVisitor::TraverseFunctionDecl(functionDecl);
insideFunctionDecl = copy2;
return ret;
}
bool Locking2::TraverseIfStmt(IfStmt* ifStmt)
{
FieldDecl const* memberFieldDecl = nullptr;
if (Expr const* cond = ifStmt->getCond())
{
if (auto memberExpr = dyn_cast<MemberExpr>(cond->IgnoreParenImpCasts()))
{
if ((memberFieldDecl = dyn_cast<FieldDecl>(memberExpr->getMemberDecl())))
insideConditionalCheckOfMemberSet.push_back(memberFieldDecl);
}
}
bool ret = RecursiveASTVisitor::TraverseIfStmt(ifStmt);
if (memberFieldDecl)
insideConditionalCheckOfMemberSet.pop_back();
return ret;
}
bool Locking2::VisitMemberExpr(const MemberExpr* memberExpr)
{
const ValueDecl* decl = memberExpr->getMemberDecl();
const FieldDecl* fieldDecl = dyn_cast<FieldDecl>(decl);
if (!fieldDecl)
{
return true;
}
fieldDecl = fieldDecl->getCanonicalDecl();
if (ignoreLocation(fieldDecl))
{
return true;
}
// ignore stuff that forms part of the stable URE interface
if (isInUnoIncludeFile(compiler.getSourceManager().getSpellingLoc(fieldDecl->getLocation())))
{
return true;
}
check(fieldDecl, memberExpr);
return true;
}
void Locking2::check(const FieldDecl* fieldDecl, const Expr* memberExpr)
{
auto parentsRange = compiler.getASTContext().getParents(*memberExpr);
const Stmt* child = memberExpr;
const Stmt* parent
= parentsRange.begin() == parentsRange.end() ? nullptr : parentsRange.begin()->get<Stmt>();
// walk up the tree until we find something interesting
bool bCannotBeConst = false;
bool bDump = false;
auto walkUp = [&]() {
child = parent;
auto parentsRange = compiler.getASTContext().getParents(*parent);
parent = parentsRange.begin() == parentsRange.end() ? nullptr
: parentsRange.begin()->get<Stmt>();
};
do
{
if (!parent)
{
// check if we have an expression like
// int& r = m_field;
auto parentsRange = compiler.getASTContext().getParents(*child);
if (parentsRange.begin() != parentsRange.end())
{
auto varDecl = dyn_cast_or_null<VarDecl>(parentsRange.begin()->get<Decl>());
// The isImplicit() call is to avoid triggering when we see the vardecl which is part of a for-range statement,
// which is of type 'T&&' and also an l-value-ref ?
if (varDecl && !varDecl->isImplicit()
&& loplugin::TypeCheck(varDecl->getType()).LvalueReference().NonConst())
{
bCannotBeConst = true;
}
}
break;
}
if (isa<CXXReinterpretCastExpr>(parent))
{
// once we see one of these, there is not much useful we can know
bCannotBeConst = true;
break;
}
else if (isa<CastExpr>(parent) || isa<MemberExpr>(parent) || isa<ParenExpr>(parent)
|| isa<ParenListExpr>(parent) || isa<ArrayInitLoopExpr>(parent)
|| isa<ExprWithCleanups>(parent))
{
walkUp();
}
else if (auto unaryOperator = dyn_cast<UnaryOperator>(parent))
{
UnaryOperator::Opcode op = unaryOperator->getOpcode();
if (op == UO_AddrOf || op == UO_PostInc || op == UO_PostDec || op == UO_PreInc
|| op == UO_PreDec)
{
bCannotBeConst = true;
}
walkUp();
}
else if (auto operatorCallExpr = dyn_cast<CXXOperatorCallExpr>(parent))
{
auto callee = getCallee(operatorCallExpr);
if (callee)
{
// if calling a non-const operator on the field
auto calleeMethodDecl = callee->getAsCXXMethodDecl();
if (calleeMethodDecl && operatorCallExpr->getArg(0) == child
&& !calleeMethodDecl->isConst())
{
bCannotBeConst = true;
}
else if (IsPassedByNonConst(fieldDecl, child, operatorCallExpr, *callee))
{
bCannotBeConst = true;
}
}
else
bCannotBeConst = true; // conservative, could improve
walkUp();
}
else if (auto cxxMemberCallExpr = dyn_cast<CXXMemberCallExpr>(parent))
{
const CXXMethodDecl* calleeMethodDecl = cxxMemberCallExpr->getMethodDecl();
if (calleeMethodDecl)
{
// if calling a non-const method on the field
const Expr* tmp = dyn_cast<Expr>(child);
if (tmp->isBoundMemberFunction(compiler.getASTContext()))
{
tmp = dyn_cast<MemberExpr>(tmp)->getBase();
}
if (cxxMemberCallExpr->getImplicitObjectArgument() == tmp
&& !calleeMethodDecl->isConst())
{
bCannotBeConst = true;
break;
}
if (IsPassedByNonConst(fieldDecl, child, cxxMemberCallExpr,
CalleeWrapper(calleeMethodDecl)))
bCannotBeConst = true;
}
else
bCannotBeConst = true; // can happen in templates
walkUp();
}
else if (auto cxxConstructExpr = dyn_cast<CXXConstructExpr>(parent))
{
if (IsPassedByNonConst(fieldDecl, child, cxxConstructExpr,
CalleeWrapper(cxxConstructExpr)))
bCannotBeConst = true;
walkUp();
}
else if (auto callExpr = dyn_cast<CallExpr>(parent))
{
auto callee = getCallee(callExpr);
if (callee)
{
if (IsPassedByNonConst(fieldDecl, child, callExpr, *callee))
bCannotBeConst = true;
}
else
bCannotBeConst = true; // conservative, could improve
walkUp();
}
else if (auto binaryOp = dyn_cast<BinaryOperator>(parent))
{
BinaryOperator::Opcode op = binaryOp->getOpcode();
const bool assignmentOp = op == BO_Assign || op == BO_MulAssign || op == BO_DivAssign
|| op == BO_RemAssign || op == BO_AddAssign
|| op == BO_SubAssign || op == BO_ShlAssign
|| op == BO_ShrAssign || op == BO_AndAssign
|| op == BO_XorAssign || op == BO_OrAssign;
if (assignmentOp)
{
if (binaryOp->getLHS() == child)
bCannotBeConst = true;
else if (loplugin::TypeCheck(binaryOp->getLHS()->getType())
.LvalueReference()
.NonConst())
// if the LHS is a non-const reference, we could write to the field later on
bCannotBeConst = true;
}
walkUp();
}
else if (isa<ReturnStmt>(parent))
{
if (insideFunctionDecl)
{
auto tc = loplugin::TypeCheck(insideFunctionDecl->getReturnType());
if (tc.LvalueReference().NonConst())
bCannotBeConst = true;
}
break;
}
else if (isa<SwitchStmt>(parent) || isa<WhileStmt>(parent) || isa<ForStmt>(parent)
|| isa<IfStmt>(parent) || isa<DoStmt>(parent) || isa<CXXForRangeStmt>(parent)
|| isa<DefaultStmt>(parent))
{
break;
}
else
{
walkUp();
}
} while (true);
if (bDump)
{
report(DiagnosticsEngine::Warning, "oh dear, what can the matter be? writtenTo=%0",
memberExpr->getBeginLoc())
<< bCannotBeConst << memberExpr->getSourceRange();
if (parent)
{
report(DiagnosticsEngine::Note, "parent over here", parent->getBeginLoc())
<< parent->getSourceRange();
parent->dump();
}
memberExpr->dump();
fieldDecl->getType()->dump();
}
if (bCannotBeConst)
{
cannotBeConstSet.insert(niceName(fieldDecl));
}
}
bool Locking2::IsPassedByNonConst(const FieldDecl* fieldDecl, const Stmt* child,
CallerWrapper callExpr, CalleeWrapper calleeFunctionDecl)
{
unsigned len = std::min(callExpr.getNumArgs(), calleeFunctionDecl.getNumParams());
// if it's an array, passing it by value to a method typically means the
// callee takes a pointer and can modify the array
if (fieldDecl->getType()->isConstantArrayType())
{
for (unsigned i = 0; i < len; ++i)
if (callExpr.getArg(i) == child)
if (loplugin::TypeCheck(calleeFunctionDecl.getParamType(i)).Pointer().NonConst())
return true;
}
else
{
for (unsigned i = 0; i < len; ++i)
if (callExpr.getArg(i) == child)
if (loplugin::TypeCheck(calleeFunctionDecl.getParamType(i))
.LvalueReference()
.NonConst())
return true;
}
return false;
}
compat::optional<CalleeWrapper> Locking2::getCallee(CallExpr const* callExpr)
{
FunctionDecl const* functionDecl = callExpr->getDirectCallee();
if (functionDecl)
return CalleeWrapper(functionDecl);
// Extract the functionprototype from a type
clang::Type const* calleeType = callExpr->getCallee()->getType().getTypePtr();
if (auto pointerType = calleeType->getUnqualifiedDesugaredType()->getAs<clang::PointerType>())
{
if (auto prototype = pointerType->getPointeeType()
->getUnqualifiedDesugaredType()
->getAs<FunctionProtoType>())
{
return CalleeWrapper(prototype);
}
}
return compat::optional<CalleeWrapper>();
}
bool Locking2::VisitCompoundStmt(const CompoundStmt* compoundStmt)
{
if (ignoreLocation(compoundStmt))
return true;
if (compoundStmt->size() < 2)
return true;
const Stmt* firstStmt = *compoundStmt->body_begin();
bool solarMutex = isSolarMutexLockGuardStmt(firstStmt);
const CXXThisExpr* ignoreThisStmt = nullptr;
if (!solarMutex)
ignoreThisStmt = isOtherMutexLockGuardStmt(firstStmt);
if (!solarMutex && ignoreThisStmt == nullptr)
return true;
const ReturnStmt* returnStmt = dyn_cast<ReturnStmt>(*(compoundStmt->body_begin() + 1));
if (!returnStmt || !returnStmt->getRetValue())
return true;
const Expr* retValue = returnStmt->getRetValue()->IgnoreImplicit();
if (auto constructExpr = dyn_cast<CXXConstructExpr>(retValue))
retValue = constructExpr->getArg(0)->IgnoreImplicit();
const MemberExpr* memberExpr = dyn_cast<MemberExpr>(retValue);
if (!memberExpr)
return true;
lockedAtSet.insert(niceNameLocked(memberExpr));
return true;
}
bool Locking2::isSolarMutexLockGuardStmt(const Stmt* stmt)
{
auto declStmt = dyn_cast<DeclStmt>(stmt);
if (!declStmt)
return false;
if (!declStmt->isSingleDecl())
return false;
auto varDecl = dyn_cast<VarDecl>(declStmt->getSingleDecl());
if (!varDecl)
return false;
auto tc = loplugin::TypeCheck(varDecl->getType());
if (!tc.Class("SolarMutexGuard").GlobalNamespace()
&& !tc.Class("SolarMutexClearableGuard").GlobalNamespace()
&& !tc.Class("SolarMutexResettableGuard").GlobalNamespace()
&& !tc.Class("SolarMutexTryAndBuyGuard").GlobalNamespace())
return false;
return true;
}
const CXXThisExpr* Locking2::isOtherMutexLockGuardStmt(const Stmt* stmt)
{
auto declStmt = dyn_cast<DeclStmt>(stmt);
if (!declStmt)
return nullptr;
if (!declStmt->isSingleDecl())
return nullptr;
auto varDecl = dyn_cast<VarDecl>(declStmt->getSingleDecl());
if (!varDecl)
return nullptr;
auto tc = loplugin::TypeCheck(varDecl->getType());
if (!tc.Class("unique_lock").StdNamespace() && !tc.Class("scoped_lock").StdNamespace()
&& !tc.Class("Guard") && !tc.Class("ClearableGuard") && !tc.Class("ResettableGuard"))
return nullptr;
auto cxxConstructExpr = dyn_cast<CXXConstructExpr>(varDecl->getInit());
if (!cxxConstructExpr || cxxConstructExpr->getNumArgs() < 1)
return nullptr;
auto arg0 = cxxConstructExpr->getArg(0);
if (auto memberExpr = dyn_cast<MemberExpr>(arg0))
{
const CXXThisExpr* thisStmt
= dyn_cast<CXXThisExpr>(memberExpr->getBase()->IgnoreImplicit());
return thisStmt;
}
else if (auto memberCallExpr = dyn_cast<CXXMemberCallExpr>(arg0))
{
return dyn_cast_or_null<CXXThisExpr>(
memberCallExpr->getImplicitObjectArgument()->IgnoreImplicit());
}
return nullptr;
}
loplugin::Plugin::Registration<Locking2> X("locking2", false);
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|