This is an archive of the discontinued LLVM Phabricator instance.

[clang-tidy] Add cppcoreguidelines-declare-not-null
AbandonedPublicDraft

Authored by fedeBuonco on Aug 18 2022, 6:08 AM.

Download Raw Diff

Details

Reviewers: None

Summary

Adds a check for C++ Core Guidelines "I.12: Declare a pointer that must not be null as not_null"
Produces a warning on pointers passed as parameters that are checked against nullptr before access, on all control-flow paths.

Diff Detail

Repository: rG LLVM Github Monorepo

Event Timeline

fedeBuonco created this revision.Aug 18 2022, 6:08 AM

Herald added a project: Restricted Project. · View Herald TranscriptAug 18 2022, 6:08 AM

Herald added subscribers: carlosgalvezp, shchenz, kbarton and 2 others. · View Herald Transcript

fedeBuonco retitled this revision from Initial commit for cppcoreguidelines-declare-not-null to [clang-tidy] Initial commit for cppcoreguidelines-declare-not-null.Aug 18 2022, 6:11 AM

Herald added a subscriber: xazax.hun. · View Herald TranscriptAug 18 2022, 6:11 AM

fedeBuonco retitled this revision from [clang-tidy] Initial commit for cppcoreguidelines-declare-not-null to [clang-tidy] Add cppcoreguidelines-declare-not-null.Aug 18 2022, 6:33 AM

fedeBuonco edited the summary of this revision. (Show Details)

Harbormaster completed remote builds in B181989: Diff 453643.Aug 18 2022, 6:45 AM

Add simple test case

Harbormaster completed remote builds in B183611: Diff 455919.Aug 26 2022, 8:32 AM

fedeBuonco abandoned this revision.Sep 7 2022, 7:44 AM

Herald added a project: Restricted Project. · View Herald TranscriptSep 7 2022, 7:44 AM

Herald added a subscriber: cfe-commits. · View Herald Transcript

Revision Contents

Path

Size

clang-tools-extra/

clang-tidy/

cppcoreguidelines/

DeclareNotNullCheck.cpp

7 lines

Diff 455919

clang-tools-extra/clang-tidy/cppcoreguidelines/DeclareNotNullCheck.cpp

	Show All 18 Lines
	void DeclareNotNullCheck::registerMatchers(MatchFinder *Finder) {			void DeclareNotNullCheck::registerMatchers(MatchFinder *Finder) {
	auto NullCondition = expr(ignoringImpCasts(anyOf(			auto NullCondition = expr(ignoringImpCasts(anyOf(
	binaryOperator(hasOperatorName("=="),			binaryOperator(hasOperatorName("=="),
	hasLHS(ignoringImpCasts(cxxNullPtrLiteralExpr())),			hasLHS(ignoringImpCasts(cxxNullPtrLiteralExpr())),
	hasRHS(ignoringImpCasts(expr().bind("exp")))),			hasRHS(ignoringImpCasts(expr().bind("exp")))),
	binaryOperator(hasOperatorName("=="),			binaryOperator(hasOperatorName("=="),
	hasLHS(ignoringImpCasts(expr().bind("exp"))),			hasLHS(ignoringImpCasts(expr().bind("exp"))),
	hasRHS(ignoringImpCasts(cxxNullPtrLiteralExpr()))))));			hasRHS(ignoringImpCasts(cxxNullPtrLiteralExpr()))))));
	auto functMatcher =			auto functMatcher = functionDecl(
	functionDecl(			hasAnyParameter(parmVarDecl(hasType(pointerType())).bind("param")));
	hasAnyParameter(parmVarDecl(hasType(pointerType())).bind("param")))
	.bind("funct");
	Finder->addMatcher(ifStmt(hasParent(compoundStmt(hasParent(functMatcher))),			Finder->addMatcher(ifStmt(hasParent(compoundStmt(hasParent(functMatcher))),
	hasCondition(NullCondition)),			hasCondition(NullCondition)),
	this);			this);
	}			}

	void DeclareNotNullCheck::check(const MatchFinder::MatchResult &Result) {			void DeclareNotNullCheck::check(const MatchFinder::MatchResult &Result) {
	const FunctionDecl *Funct = Result.Nodes.getNodeAs<FunctionDecl>("funct");
	const ParmVarDecl *Par = Result.Nodes.getNodeAs<ParmVarDecl>("param");			const ParmVarDecl *Par = Result.Nodes.getNodeAs<ParmVarDecl>("param");
	const Expr *Ex = Result.Nodes.getNodeAs<Expr>("exp");			const Expr *Ex = Result.Nodes.getNodeAs<Expr>("exp");
	diag(Ex->getExprLoc(), "pointer parameter checked against nullptr") << Par;			diag(Ex->getExprLoc(), "pointer parameter checked against nullptr") << Par;
	diag(Par->getLocation(), "consider declaring as not_null",			diag(Par->getLocation(), "consider declaring as not_null",
	DiagnosticIDs::Note);			DiagnosticIDs::Note);
	}			}

	} // namespace cppcoreguidelines			} // namespace cppcoreguidelines
	} // namespace tidy			} // namespace tidy
	} // namespace clang			} // namespace clang