mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adapt to changed clang::ASTContext::getParents behavior on Clang 11 trunk

Browse Source 
...since <https://github.com/llvm/llvm-project/commit/
d0da5d2bbe8305d06dc01a98706fd73e11e24a9f> "Change default traversal in AST
Matchers to ignore invisible nodes".  This caused failures

> [CPT] compilerplugins/clang/test/constparams.cxx
> ParmVarDecl 0x11d76c730 <compilerplugins/clang/test/constparams.cxx:15:12, col:18> col:18 used f1 'int *'
> DeclRefExpr 0x11d76c948 'int *' lvalue ParmVar 0x11d76c730 'f1' 'int *'
> ParmVarDecl 0x11d76cc80 <compilerplugins/clang/test/constparams.cxx:21:12, col:18> col:18 used f2 'int *'
> DeclRefExpr 0x11d76ce60 'int *' lvalue ParmVar 0x11d76cc80 'f2' 'int *'
> error: 'error' diagnostics expected but not seen:
>   File compilerplugins/clang/test/constparams.cxx Line 15: this parameter can be const Class1::Class1 [loplugin:constparams]
> error: 'error' diagnostics seen but not expected:
>   File compilerplugins/clang/test/constparams.cxx Line 15: no parent? [loplugin:constparams]
>   File compilerplugins/clang/test/constparams.cxx Line 21: no parent? [loplugin:constparams]
> 3 errors generated.
[...]
> [CPT] compilerplugins/clang/test/unusedenumconstants.cxx
> error: 'error' diagnostics expected but not seen:
>   File compilerplugins/clang/test/unusedenumconstants.cxx Line 30: read Bottom [loplugin:unusedenumconstants]
> error: 'error' diagnostics seen but not expected:
>   File compilerplugins/clang/test/unusedenumconstants.cxx Line 30: write Bottom [loplugin:unusedenumconstants]
> 2 errors generated.
[...]
> [CPT] compilerplugins/clang/test/unusedfields.cxx
> error: 'error' diagnostics expected but not seen:
>   File compilerplugins/clang/test/unusedfields.cxx Line 156 (directive at compilerplugins/clang/test/unusedfields.cxx:164): write m_f5 [loplugin:unusedfields]
>   File compilerplugins/clang/test/unusedfields.cxx Line 210 (directive at compilerplugins/clang/test/unusedfields.cxx:211): read m_f1 [loplugin:unusedfields]
> 2 errors generated.

For compilerplugins/clang/test/constparams.cxx at least it would have worked to
fix that locally with

> diff --git a/compilerplugins/clang/constparams.cxx b/compilerplugins/clang/constparams.cxx
> index 95c8184009d7..70f056fa5a69 100644
> --- a/compilerplugins/clang/constparams.cxx
> +++ b/compilerplugins/clang/constparams.cxx
> @@ -274,7 +274,7 @@ bool ConstParams::checkIfCanBeConst(const Stmt* stmt, const ParmVarDecl* parmVar
>              {
>                  for ( auto cxxCtorInitializer : cxxConstructorDecl->inits())
>                  {
> -                    if ( cxxCtorInitializer->getInit() == stmt)
> +                    if ( cxxCtorInitializer->getInit()->IgnoreImpCasts() == stmt)
>                      {
>                          if (cxxCtorInitializer->isAnyMemberInitializer())
>                          {

(somewhat unintuitively, given the Clang change is apparently about ignoring
more implicit nodes), but overall it appears better---at least for now---to use
a getParents variant that keeps the old traversal behavior.

For that, instead of using the clang::ASTContext::ParentMapCtx, we create our
own loplugin::Plugin::parentMapContext_.  There appear to be no uses of
ASTContext::getParent across the Clang codebase itself, outside of ASTMatcher
code, so it looks unlikely that creating our own ParentMapContext instance would
degrade performance by no longer sharing cached data between Clang's internals
and our plugin.  (And given that ASTContext::getParents is deprecated with the
note "New callers should use ParentMapContext::getParents() directly", this may
well be the correct way in the long run, anyway.)

Change-Id: I46c7912f2737e7c224fd45ab41441f69e2f10bd4
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/94795
Tested-by: Jenkins
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
This commit is contained in:
Stephan Bergmann
2020-05-25 15:50:21 +02:00
parent df50b02cd3
commit 09aa5a9be8
11 changed files with 81 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
compilerplugins/clang/compat.hxx
View File

@@ -24,6 +24,12 @@
#include "config_clang.h"
#if CLANG_VERSION >= 110000
namespace clang { class DynTypedNodeList; }
#else
#include "clang/AST/ASTContext.h"
#endif
// Compatibility wrapper to abstract over (trivial) changes in the Clang API:
namespace compat {
@@ -289,6 +295,12 @@ inline clang::QualType getDeclaredReturnType(clang::FunctionDecl const * decl) {
#endif
}
#if CLANG_VERSION >= 110000
using DynTypedNodeList = clang::DynTypedNodeList;
#else
using DynTypedNodeList = clang::ASTContext::DynTypedNodeList;
#endif
}
#endif

6
compilerplugins/clang/constfields.cxx
View File

@@ -360,7 +360,7 @@ bool ConstFields::VisitMemberExpr(const MemberExpr* memberExpr)
void ConstFields::check(const FieldDecl* fieldDecl, const Expr* memberExpr)
{
auto parentsRange = compiler.getASTContext().getParents(*memberExpr);
auto parentsRange = getParents(*memberExpr);
const Stmt* child = memberExpr;
const Stmt* parent
= parentsRange.begin() == parentsRange.end() ? nullptr : parentsRange.begin()->get<Stmt>();
@@ -369,7 +369,7 @@ void ConstFields::check(const FieldDecl* fieldDecl, const Expr* memberExpr)
bool bDump = false;
auto walkUp = [&]() {
child = parent;
auto parentsRange = compiler.getASTContext().getParents(*parent);
auto parentsRange = getParents(*parent);
parent = parentsRange.begin() == parentsRange.end() ? nullptr
: parentsRange.begin()->get<Stmt>();
};
@@ -379,7 +379,7 @@ void ConstFields::check(const FieldDecl* fieldDecl, const Expr* memberExpr)
{
// check if we have an expression like
// int& r = m_field;
auto parentsRange = compiler.getASTContext().getParents(*child);
auto parentsRange = getParents(*child);
if (parentsRange.begin() != parentsRange.end())
{
auto varDecl = dyn_cast_or_null<VarDecl>(parentsRange.begin()->get<Decl>());

2
compilerplugins/clang/constmethod.cxx
View File

@@ -194,7 +194,7 @@ bool ConstMethod::checkIfCanBeConst(const Stmt* stmt, const CXXMethodDecl* cxxMe
{
const Stmt* parent = getParentStmt( stmt );
if (!parent) {
auto parentsRange = compiler.getASTContext().getParents(*stmt);
auto parentsRange = getParents(*stmt);
if ( parentsRange.begin() == parentsRange.end())
return true;
auto varDecl = dyn_cast_or_null<VarDecl>(parentsRange.begin()->get<Decl>());

2
compilerplugins/clang/constparams.cxx
View File

@@ -267,7 +267,7 @@ bool ConstParams::checkIfCanBeConst(const Stmt* stmt, const ParmVarDecl* parmVar
if (!parent)
{
// check if we're inside a CXXCtorInitializer
auto parentsRange = compiler.getASTContext().getParents(*stmt);
auto parentsRange = getParents(*stmt);
if ( parentsRange.begin() != parentsRange.end())
{
if (auto cxxConstructorDecl = dyn_cast_or_null<CXXConstructorDecl>(parentsRange.begin()->get<Decl>()))

8
compilerplugins/clang/constvars.cxx
View File

@@ -304,7 +304,7 @@ bool ConstVars::VisitDeclRefExpr(const DeclRefExpr* declRefExpr)
void ConstVars::check(const VarDecl* varDecl, const Expr* memberExpr)
{
auto parentsRange = compiler.getASTContext().getParents(*memberExpr);
auto parentsRange = getParents(*memberExpr);
const Stmt* child = memberExpr;
const Stmt* parent
= parentsRange.begin() == parentsRange.end() ? nullptr : parentsRange.begin()->get<Stmt>();
@@ -315,7 +315,7 @@ void ConstVars::check(const VarDecl* varDecl, const Expr* memberExpr)
bool bDump = false;
auto walkUp = [&]() {
child = parent;
auto parentsRange = compiler.getASTContext().getParents(*parent);
auto parentsRange = getParents(*parent);
parent = parentsRange.begin() == parentsRange.end() ? nullptr
: parentsRange.begin()->get<Stmt>();
};
@@ -325,7 +325,7 @@ void ConstVars::check(const VarDecl* varDecl, const Expr* memberExpr)
{
// check if we have an expression like
// int& r = var;
auto parentsRange = compiler.getASTContext().getParents(*child);
auto parentsRange = getParents(*child);
if (parentsRange.begin() != parentsRange.end())
{
auto varDecl = dyn_cast_or_null<VarDecl>(parentsRange.begin()->get<Decl>());
@@ -334,7 +334,7 @@ void ConstVars::check(const VarDecl* varDecl, const Expr* memberExpr)
if (varDecl->isImplicit())
{
// so we can walk up from inside a for-range stmt
parentsRange = compiler.getASTContext().getParents(*varDecl);
parentsRange = getParents(*varDecl);
if (parentsRange.begin() != parentsRange.end())
parent = parentsRange.begin()->get<Stmt>();
}

38
compilerplugins/clang/plugin.cxx
View File

@@ -184,9 +184,35 @@ bool Plugin::evaluate(const Expr* expr, APSInt& x)
return false;
}
compat::DynTypedNodeList Plugin::getParents(Decl const & decl)
{
#if CLANG_VERSION >= 110000
if (!parentMapContext_) {
parentMapContext_.reset(new ParentMapContext(compiler.getASTContext()));
parentMapContext_->setTraversalKind(TK_AsIs);
}
return parentMapContext_->getParents(decl);
#else
return compiler.getASTContext().getParents(decl);
#endif
}
compat::DynTypedNodeList Plugin::getParents(Stmt const & stmt)
{
#if CLANG_VERSION >= 110000
if (!parentMapContext_) {
parentMapContext_.reset(new ParentMapContext(compiler.getASTContext()));
parentMapContext_->setTraversalKind(TK_AsIs);
}
return parentMapContext_->getParents(stmt);
#else
return compiler.getASTContext().getParents(stmt);
#endif
}
const Stmt* Plugin::getParentStmt( const Stmt* stmt )
{
auto parentsRange = compiler.getASTContext().getParents(*stmt);
auto parentsRange = getParents(*stmt);
if ( parentsRange.begin() == parentsRange.end())
return nullptr;
return parentsRange.begin()->get<Stmt>();
@@ -194,15 +220,15 @@ const Stmt* Plugin::getParentStmt( const Stmt* stmt )
Stmt* Plugin::getParentStmt( Stmt* stmt )
{
auto parentsRange = compiler.getASTContext().getParents(*stmt);
auto parentsRange = getParents(*stmt);
if ( parentsRange.begin() == parentsRange.end())
return nullptr;
return const_cast<Stmt*>(parentsRange.begin()->get<Stmt>());
}
const Decl* getFunctionDeclContext(ASTContext& context, const Stmt* stmt)
const Decl* Plugin::getFunctionDeclContext(const Stmt* stmt)
{
auto const parents = context.getParents(*stmt);
auto const parents = getParents(*stmt);
auto it = parents.begin();
if (it == parents.end())
@@ -218,14 +244,14 @@ const Decl* getFunctionDeclContext(ASTContext& context, const Stmt* stmt)
stmt = it->get<Stmt>();
if (stmt)
return getFunctionDeclContext(context, stmt);
return getFunctionDeclContext(stmt);
return nullptr;
}
const FunctionDecl* Plugin::getParentFunctionDecl( const Stmt* stmt )
{
const Decl *decl = getFunctionDeclContext(compiler.getASTContext(), stmt);
const Decl *decl = getFunctionDeclContext(stmt);
if (decl)
return static_cast<const FunctionDecl*>(decl->getNonClosureContext());

15
compilerplugins/clang/plugin.hxx
View File

@@ -18,6 +18,8 @@
#include <clang/Basic/SourceManager.h>
#include <clang/Frontend/CompilerInstance.h>
#include <clang/Lex/Preprocessor.h>
#include <memory>
#include <unordered_map>
#include <vector>
@@ -26,6 +28,10 @@
#include "compat.hxx"
#include "pluginhandler.hxx"
#if CLANG_VERSION >= 110000
#include "clang/AST/ParentMapContext.h"
#endif
using namespace clang;
using namespace llvm;
@@ -78,8 +84,11 @@ protected:
Returns the parent of the given AST node. Clang's internal AST representation doesn't provide this information,
it can only provide children, but getting the parent is often useful for inspecting a part of the AST.
*/
compat::DynTypedNodeList getParents(Decl const & decl);
compat::DynTypedNodeList getParents(Stmt const & stmt);
const Stmt* getParentStmt( const Stmt* stmt );
Stmt* getParentStmt( Stmt* stmt );
const Decl* getFunctionDeclContext(const Stmt* stmt);
const FunctionDecl* getParentFunctionDecl( const Stmt* stmt );
/**
@@ -112,6 +121,10 @@ private:
enum { isRewriter = false };
const char* name;
#if CLANG_VERSION >= 110000
std::unique_ptr<ParentMapContext> parentMapContext_;
#endif
};
template<typename Derived>
@@ -309,8 +322,6 @@ bool hasExternalLinkage(VarDecl const * decl);
bool isSmartPointerType(const clang::Type*);
bool isSmartPointerType(const Expr*);
const Decl* getFunctionDeclContext(ASTContext& context, const Stmt* stmt);
} // namespace
#endif // COMPILEPLUGIN_H

2
compilerplugins/clang/singlevalfields.cxx
View File

@@ -315,7 +315,7 @@ void SingleValFields::walkPotentialAssign( const DeclaratorDecl* fieldOrVarDecl,
while (!bPotentiallyAssignedTo) {
// check for field being accessed by a reference variable e.g. Foo& f = m.foo;
auto parentsList = compiler.getASTContext().getParents(*child);
auto parentsList = getParents(*child);
auto it = parentsList.begin();
if (it != parentsList.end()) {
const VarDecl *varDecl = it->get<VarDecl>();

14
compilerplugins/clang/unusedfields.cxx
View File

@@ -531,7 +531,7 @@ void UnusedFields::checkIfReadFrom(const FieldDecl* fieldDecl, const Expr* membe
return;
}
auto parentsRange = compiler.getASTContext().getParents(*memberExpr);
auto parentsRange = 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
@@ -539,7 +539,7 @@ void UnusedFields::checkIfReadFrom(const FieldDecl* fieldDecl, const Expr* membe
bool bDump = false;
auto walkUp = [&]() {
child = parent;
auto parentsRange = compiler.getASTContext().getParents(*parent);
auto parentsRange = getParents(*parent);
parent = parentsRange.begin() == parentsRange.end() ? nullptr : parentsRange.begin()->get<Stmt>();
};
do
@@ -547,7 +547,7 @@ void UnusedFields::checkIfReadFrom(const FieldDecl* fieldDecl, const Expr* membe
if (!parent)
{
// check if we're inside a CXXCtorInitializer or a VarDecl
auto parentsRange = compiler.getASTContext().getParents(*child);
auto parentsRange = getParents(*child);
if ( parentsRange.begin() != parentsRange.end())
{
const Decl* decl = parentsRange.begin()->get<Decl>();
@@ -779,7 +779,7 @@ void UnusedFields::checkIfWrittenTo(const FieldDecl* fieldDecl, const Expr* memb
if (std::find(insideConditionalCheckOfMemberSet.begin(), insideConditionalCheckOfMemberSet.end(), fieldDecl) != insideConditionalCheckOfMemberSet.end())
return;
auto parentsRange = compiler.getASTContext().getParents(*memberExpr);
auto parentsRange = 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
@@ -787,7 +787,7 @@ void UnusedFields::checkIfWrittenTo(const FieldDecl* fieldDecl, const Expr* memb
bool bDump = false;
auto walkUp = [&]() {
child = parent;
auto parentsRange = compiler.getASTContext().getParents(*parent);
auto parentsRange = getParents(*parent);
parent = parentsRange.begin() == parentsRange.end() ? nullptr : parentsRange.begin()->get<Stmt>();
};
do
@@ -796,7 +796,7 @@ void UnusedFields::checkIfWrittenTo(const FieldDecl* fieldDecl, const Expr* memb
{
// check if we have an expression like
// int& r = m_field;
auto parentsRange = compiler.getASTContext().getParents(*child);
auto parentsRange = getParents(*child);
if (parentsRange.begin() != parentsRange.end())
{
auto varDecl = dyn_cast_or_null<VarDecl>(parentsRange.begin()->get<Decl>());
@@ -1157,7 +1157,7 @@ void UnusedFields::checkTouchedFromOutside(const FieldDecl* fieldDecl, const Exp
if (memberExprParentFunction)
memberExprParentFunction->dump();
memberExpr->dump();
const Decl *decl = loplugin::getFunctionDeclContext(compiler.getASTContext(), memberExpr);
const Decl *decl = getFunctionDeclContext(memberExpr);
if (decl)
decl->dump();
std::cout << "site1" << std::endl;

2
compilerplugins/clang/unusedvariablemore.cxx
View File

@@ -208,7 +208,7 @@ bool UnusedVariableMore::checkifUnused(Stmt const* stmt, VarDecl const* varDecl)
if (!parent)
{
// check if we're inside a CXXCtorInitializer
auto parentsRange = compiler.getASTContext().getParents(*stmt);
auto parentsRange = getParents(*stmt);
if (parentsRange.begin() != parentsRange.end())
{
auto parentDecl = parentsRange.begin()->get<Decl>();

12
compilerplugins/clang/writeonlyvars.cxx
View File

@@ -593,7 +593,7 @@ bool WriteOnlyVars::TraverseIfStmt(IfStmt* ifStmt)
void WriteOnlyVars::checkIfReadFrom(const VarDecl* varDecl, const Expr* memberExpr)
{
auto parentsRange = compiler.getASTContext().getParents(*memberExpr);
auto parentsRange = getParents(*memberExpr);
const Stmt* child = memberExpr;
const Stmt* parent
= parentsRange.begin() == parentsRange.end() ? nullptr : parentsRange.begin()->get<Stmt>();
@@ -602,7 +602,7 @@ void WriteOnlyVars::checkIfReadFrom(const VarDecl* varDecl, const Expr* memberEx
bool bDump = false;
auto walkupUp = [&]() {
child = parent;
auto parentsRange = compiler.getASTContext().getParents(*parent);
auto parentsRange = getParents(*parent);
parent = parentsRange.begin() == parentsRange.end() ? nullptr
: parentsRange.begin()->get<Stmt>();
};
@@ -611,7 +611,7 @@ void WriteOnlyVars::checkIfReadFrom(const VarDecl* varDecl, const Expr* memberEx
if (!parent)
{
// check if we're inside a CXXCtorInitializer or a VarDecl
auto parentsRange = compiler.getASTContext().getParents(*child);
auto parentsRange = getParents(*child);
if (parentsRange.begin() != parentsRange.end())
{
const Decl* decl = parentsRange.begin()->get<Decl>();
@@ -810,7 +810,7 @@ void WriteOnlyVars::checkIfWrittenTo(const VarDecl* varDecl, const Expr* memberE
!= insideConditionalCheckOfMemberSet.end())
return;
auto parentsRange = compiler.getASTContext().getParents(*memberExpr);
auto parentsRange = getParents(*memberExpr);
const Stmt* child = memberExpr;
const Stmt* parent
= parentsRange.begin() == parentsRange.end() ? nullptr : parentsRange.begin()->get<Stmt>();
@@ -819,7 +819,7 @@ void WriteOnlyVars::checkIfWrittenTo(const VarDecl* varDecl, const Expr* memberE
bool bDump = false;
auto walkupUp = [&]() {
child = parent;
auto parentsRange = compiler.getASTContext().getParents(*parent);
auto parentsRange = getParents(*parent);
parent = parentsRange.begin() == parentsRange.end() ? nullptr
: parentsRange.begin()->get<Stmt>();
};
@@ -829,7 +829,7 @@ void WriteOnlyVars::checkIfWrittenTo(const VarDecl* varDecl, const Expr* memberE
{
// check if we have an expression like
// int& r = var;
auto parentsRange = compiler.getASTContext().getParents(*child);
auto parentsRange = getParents(*child);
if (parentsRange.begin() != parentsRange.end())
{
auto varDecl = dyn_cast_or_null<VarDecl>(parentsRange.begin()->get<Decl>());