Merge pull request #1241 from gartung/updateClangChecker

Static Analyzer improvement -- ignore mutable and static warnings for std::atomic<>, std::mutex, ...

Utilities/StaticAnalyzers/src/ClassChecker.cpp

@@ -15,7 +15,18 @@
 //		pass by const ref & pointer OK
 //
 //
-
+#include <clang/AST/Decl.h>
+#include <clang/AST/DeclTemplate.h>
+#include <clang/AST/DeclCXX.h>
+#include <clang/AST/StmtVisitor.h>
+#include <clang/AST/ParentMap.h>
+#include <clang/Analysis/CFGStmtMap.h>
+#include <clang/StaticAnalyzer/Core/Checker.h>
+#include <clang/StaticAnalyzer/Core/BugReporter/BugReporter.h>
+#include <clang/StaticAnalyzer/Core/BugReporter/BugType.h>
+#include <clang/StaticAnalyzer/Core/PathSensitive/AnalysisManager.h>
+#include <llvm/Support/SaveAndRestore.h>
+#include <llvm/ADT/SmallString.h>
 
 #include "ClassChecker.h"
 
@@ -288,6 +299,7 @@ void WalkAST::VisitDeclRefExpr( clang::DeclRefExpr * DRE) {
   if (clang::VarDecl * D = llvm::dyn_cast<clang::VarDecl>(DRE->getDecl()) ) { 
   	clang::SourceLocation SL = DRE->getLocStart();
   	if (BR.getSourceManager().isInSystemHeader(SL) || BR.getSourceManager().isInExternCSystemHeader(SL)) return;
+	if ( support::isSafeClassName( D->getCanonicalDecl()->getQualifiedNameAsString() ) ) return;
 	ReportDeclRef( DRE );
 
 //	llvm::errs()<<"Declaration Ref Expr\t";
@@ -618,21 +630,23 @@ void ClassChecker::checkASTDecl(const clang::CXXRecordDecl *RD, clang::ento::Ana
 
   	llvm::SmallString<100> buf;
   	llvm::raw_svector_ostream os(buf);
-	clang::FileSystemOptions FSO;
-	clang::FileManager FM(FSO);
-	const char * pPath = std::getenv("LOCALRT");
-	std::string dname(""); 
-	if ( pPath != NULL ) dname = std::string(pPath);
-	std::string fname("/tmp/classes.txt");
-	std::string tname = dname + fname;
-	if (!FM.getFile(tname) ) {
-		llvm::errs()<<"\n\nChecker optional.ClassChecker cannot find $LOCALRT/tmp/classes.txt. Run 'scram b checker' with USER_LLVM_CHECKERS='-enable-checker optional.ClassDumperCT -enable-checker optional.ClassDumperFT' to create $LOCALRT/tmp/classes.txt.\n\n\n";
-		exit(1);
-		}
-	llvm::MemoryBuffer * buffer = FM.getBufferForFile(FM.getFile(tname));
-		os <<"class "<<RD->getQualifiedNameAsString()<<"\n";
-		llvm::StringRef Rname(os.str());
-		if (buffer->getBuffer().find(Rname) == llvm::StringRef::npos ) {return;}
+//	clang::FileSystemOptions FSO;
+//	clang::FileManager FM(FSO);
+//	const char * pPath = std::getenv("LOCALRT");
+//	std::string dname(""); 
+//	if ( pPath != NULL ) dname = std::string(pPath);
+//	std::string fname("/tmp/classes.txt");
+//	std::string tname = dname + fname;
+//	if (!FM.getFile(tname) ) {
+//		llvm::errs()<<"\n\nChecker optional.ClassChecker cannot find $LOCALRT/tmp/classes.txt. Run 'scram b checker' with USER_LLVM_CHECKERS='-enable-checker optional.ClassDumperCT -enable-checker optional.ClassDumperFT' to create $LOCALRT/tmp/classes.txt.\n\n\n";
+//		exit(1);
+//		}
+//	llvm::MemoryBuffer * buffer = FM.getBufferForFile(FM.getFile(tname));
+//		os <<"class "<<RD->getQualifiedNameAsString()<<"\n";
+//		llvm::StringRef Rname(os.str());
+//		if (buffer->getBuffer().find(Rname) == llvm::StringRef::npos ) {return;}
+	std::string name = RD->getQualifiedNameAsString();
+	if ( ! support::isDataClass(name) ) return;
 	clang::ento::PathDiagnosticLocation DLoc =clang::ento::PathDiagnosticLocation::createBegin( RD, SM );
 	if (  !m_exception.reportClass( DLoc, BR ) ) return;
 //	clangcms::WalkAST walker(BR, mgr.getAnalysisDeclContext(RD));

Utilities/StaticAnalyzers/src/ClassChecker.h

@@ -1,17 +1,8 @@
 #ifndef Utilities_StaticAnalyzers_MemberChecker_h
 #define Utilities_StaticAnalyzers_MemberChecker_h
-#include <clang/AST/DeclCXX.h>
-#include <clang/AST/Decl.h>
-#include <clang/AST/DeclTemplate.h>
-#include <clang/AST/StmtVisitor.h>
-#include <clang/AST/ParentMap.h>
-#include <clang/Analysis/CFGStmtMap.h>
-#include <llvm/Support/SaveAndRestore.h>
-#include <clang/StaticAnalyzer/Core/PathSensitive/AnalysisManager.h>
 #include <clang/StaticAnalyzer/Core/Checker.h>
-#include <clang/StaticAnalyzer/Core/BugReporter/BugReporter.h>
+#include <clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h>
 #include <clang/StaticAnalyzer/Core/BugReporter/BugType.h>
-#include <llvm/ADT/SmallString.h>
 
 #include "CmsException.h"
 #include "CmsSupport.h"

Utilities/StaticAnalyzers/src/CmsSupport.cpp

@@ -3,12 +3,19 @@
 // by Shahzad Malik MUZAFFAR [ Shahzad.Malik.MUZAFFAR@cern.ch ]
 //
 //===----------------------------------------------------------------------===//
-
+#include <clang/Basic/FileManager.h>
+#include <clang/StaticAnalyzer/Core/Checker.h>
+#include <clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h>
+#include <clang/StaticAnalyzer/Core/BugReporter/BugType.h>
+#include <llvm/ADT/SmallString.h>
+#include "llvm/Support/raw_ostream.h"
 #include "CmsSupport.h"
 #include <cstdlib>
 #include <cstring>
+
 using namespace clangcms;
 using namespace clang;
+using namespace llvm;
 bool support::isCmsLocalFile(const char* file)
 {
   static char* LocalDir=0;
@@ -74,4 +81,47 @@ std::string support::getQualifiedName(const clang::NamedDecl &d) {
   return ret;
 }
 
+bool support::isSafeClassName(const std::string &name) {
+  std::string atomic = "std::atomic<";
+  std::string mutex = "std::mutex";
+  std::string rmutex = "std::recursive_mutex";
+  std::string btsp = "boost::thread_specific_ptr<";
+
+  if ( name.substr(0,atomic.length()) == atomic || name.substr(0,mutex.length()) == mutex
+	|| name.substr(0,rmutex.length()) == rmutex || name.substr(0,btsp.length()) == btsp )
+	return true;	
+  return false;
+}
 
+bool support::isDataClass(const std::string & name) {
+        std::string buf;
+        llvm::raw_string_ostream os(buf);
+	clang::FileSystemOptions FSO;
+	clang::FileManager FM(FSO);
+	const char * lPath = std::getenv("LOCALRT");
+	const char * rPath = std::getenv("CMSSW_RELEASE_BASE");
+	std::string lname(""); 
+	std::string rname(""); 
+	if ( lPath != NULL && rPath != NULL ) {
+		lname = std::string(lPath);
+		rname = std::string(rPath);
+	}
+
+	std::string tname("/tmp/classes.txt");
+	std::string sname("/Utilities/StaticAnalyzers/scripts/classes.txt");
+	std::string fname1 = lname + tname;
+	std::string fname2 = rname + sname;
+	if (!FM.getFile(fname1) && !FM.getFile(fname2) ) {
+		llvm::errs()<<"\n\nChecker cannot find classes.txt. Run \"USER_LLVM_CHECKERS='-enable-checker optional.ClassDumperCT -enable-checker optional.ClassDumperFT scram b checker to create $LOCALRT/tmp/classes.txt.\n\n\n";
+		exit(1);
+		}
+	llvm::MemoryBuffer * buffer;
+	if ( FM.getFile(fname1) ) 
+		buffer = FM.getBufferForFile(FM.getFile(fname1));
+	else 
+		buffer = FM.getBufferForFile(FM.getFile(fname2));	
+	os <<"class "<< name <<"\n";
+	llvm::StringRef Rname(os.str());
+	if ( buffer->getBuffer().find(Rname) == llvm::StringRef::npos ) return false;
+	return true;
+}

Utilities/StaticAnalyzers/src/CmsSupport.h

@@ -11,6 +11,7 @@
 
 #include <clang/AST/Type.h>
 #include <clang/AST/Decl.h>
+#include <clang/AST/DeclCXX.h>
 
 namespace clangcms {
 
@@ -45,6 +46,8 @@ inline bool isConst( clang::QualType const& qt )
 
 bool isCmsLocalFile(const char* file);
 std::string getQualifiedName(const clang::NamedDecl &d);
+bool isSafeClassName(const std::string &d);
+bool isDataClass(const std::string &d);
 }
 } 
 

Utilities/StaticAnalyzers/src/FunctionChecker.cpp

@@ -1,4 +1,20 @@
+#include <clang/AST/DeclCXX.h>
+#include <clang/AST/Decl.h>
+#include <clang/AST/DeclTemplate.h>
+#include <clang/AST/StmtVisitor.h>
+#include <clang/AST/ParentMap.h>
+#include <clang/Analysis/CFGStmtMap.h>
+#include <clang/Analysis/CallGraph.h>
+#include <llvm/Support/SaveAndRestore.h>
+#include <clang/StaticAnalyzer/Core/PathSensitive/AnalysisManager.h>
+#include <clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h>
+#include <clang/StaticAnalyzer/Core/Checker.h>
+#include <clang/StaticAnalyzer/Core/BugReporter/BugReporter.h>
+#include <clang/StaticAnalyzer/Core/BugReporter/BugType.h>
+#include <llvm/ADT/SmallString.h>
+
 #include "FunctionChecker.h"
+
 using namespace clang;
 using namespace ento;
 using namespace llvm;
@@ -37,7 +53,8 @@ void FWalker::VisitChildren( clang::Stmt *S) {
 
 
 void FWalker::VisitDeclRefExpr( clang::DeclRefExpr * DRE) {
-  if (clang::VarDecl * D = llvm::dyn_cast<clang::VarDecl>(DRE->getDecl()) ) { 
+  if (clang::VarDecl * D = llvm::dyn_cast<clang::VarDecl>(DRE->getDecl()) ) {
+	if ( support::isSafeClassName(D->getCanonicalDecl()->getQualifiedNameAsString() ) ) return;
 	ReportDeclRef(DRE);
 //	llvm::errs()<<"Declaration Ref Expr\t";
 //	dyn_cast<Stmt>(DRE)->dumpPretty(AC->getASTContext());
@@ -57,19 +74,25 @@ void FWalker::ReportDeclRef ( const clang::DeclRefExpr * DRE) {
   	clang::PrintingPolicy Policy(LangOpts);
 	const Decl * PD = AC->getDecl();
 	std::string dname =""; 
-	if (const NamedDecl * ND = llvm::dyn_cast<NamedDecl>(PD)) dname = support::getQualifiedName(*ND);
+	std::string sdname =""; 
+	if (const NamedDecl * ND = llvm::dyn_cast<NamedDecl>(PD)) {
+		sdname = support::getQualifiedName(*ND);
+		dname = ND->getQualifiedNameAsString();
+	}
 
-  	clang::ento::PathDiagnosticLocation CELoc = clang::ento::PathDiagnosticLocation::createBegin(DRE, BR.getSourceManager(),AC);
+ // 	clang::ento::PathDiagnosticLocation CELoc = clang::ento::PathDiagnosticLocation::createBegin(DRE, BR.getSourceManager(),AC);
+  	clang::ento::PathDiagnosticLocation DLoc = clang::ento::PathDiagnosticLocation::createBegin(D, BR.getSourceManager());
 
 	if ( (D->isStaticLocal() && D->getTSCSpec() != clang::ThreadStorageClassSpecifier::TSCS_thread_local ) && ! clangcms::support::isConst( t ) )
 	{
 		std::string buf;
 	    	llvm::raw_string_ostream os(buf);
 	   	os << "function '"<<dname << "' accesses or modifies non-const static local variable '" << D->getNameAsString() << "'.\n";
-	    	BugType * BT = new BugType("FunctionChecker : non-const static local variable accessed or modified","ThreadSafety");
-		BugReport * R = new BugReport(*BT,os.str(),CELoc);
-		BR.emitReport(R);
- 		llvm::errs() <<  "function '"<<dname << "' static variable '" << D->getNameAsString() << "'.\n\n";
+//	    	BugType * BT = new BugType("FunctionChecker : non-const static local variable accessed or modified","ThreadSafety");
+//		BugReport * R = new BugReport(*BT,os.str(),CELoc);
+//		BR.emitReport(R);
+		BR.EmitBasicReport(D, "FunctionChecker : non-const static local variable accessed or modified","ThreadSafety",os.str(), DLoc);
+ 		llvm::errs() <<  "function '"<<sdname << "' static variable '" << D->getNameAsString() << "'.\n\n";
 		return;
 	}
 
@@ -78,10 +101,11 @@ void FWalker::ReportDeclRef ( const clang::DeclRefExpr * DRE) {
 	    	std::string buf;
 	    	llvm::raw_string_ostream os(buf);
 	    	os << "function '"<<dname<< "' accesses or modifies non-const static member data variable '" << D->getNameAsString() << "'.\n";
-	    	BugType * BT = new BugType("FunctionChecker : non-const static member variable accessed or modified","ThreadSafety");
-		BugReport * R = new BugReport(*BT,os.str(),CELoc);
-		BR.emitReport(R);
- 		llvm::errs() <<  "function '"<<dname << "' static variable '" << D->getNameAsString() << "'.\n\n";
+//	    	BugType * BT = new BugType("FunctionChecker : non-const static member variable accessed or modified","ThreadSafety");
+//		BugReport * R = new BugReport(*BT,os.str(),CELoc);
+//		BR.emitReport(R);
+		BR.EmitBasicReport(D, "FunctionChecker : non-const static local variable accessed or modified","ThreadSafety",os.str(), DLoc);
+ 		llvm::errs() <<  "function '"<<sdname << "' static variable '" << D->getNameAsString() << "'.\n\n";
 	    return;
 	}
 
@@ -95,10 +119,11 @@ void FWalker::ReportDeclRef ( const clang::DeclRefExpr * DRE) {
 	    	std::string buf;
 	    	llvm::raw_string_ostream os(buf);
 	    	os << "function '"<<dname << "' accesses or modifies non-const global static variable '" << D->getNameAsString() << "'.\n";
-	    	BugType * BT = new BugType("FunctionChecker : non-const global static variable accessed or modified","ThreadSafety");
-		BugReport * R = new BugReport(*BT,os.str(),CELoc);
-		BR.emitReport(R);
- 		llvm::errs() <<  "function '"<<dname << "' static variable '" << D->getNameAsString() << "'.\n\n";
+//	    	BugType * BT = new BugType("FunctionChecker : non-const global static variable accessed or modified","ThreadSafety");
+//		BugReport * R = new BugReport(*BT,os.str(),CELoc);
+//		BR.emitReport(R);
+		BR.EmitBasicReport(D, "FunctionChecker : non-const static local variable accessed or modified","ThreadSafety",os.str(), DLoc);
+ 		llvm::errs() <<  "function '"<<sdname << "' static variable '" << D->getNameAsString() << "'.\n\n";
 	    return;
 
 	}

Utilities/StaticAnalyzers/src/FunctionChecker.h

@@ -1,19 +1,8 @@
 #ifndef Utilities_StaticAnalyzers_FunctionChecker_h
 #define Utilities_StaticAnalyzers_FunctionChecker_h
-#include <clang/AST/DeclCXX.h>
-#include <clang/AST/Decl.h>
-#include <clang/AST/DeclTemplate.h>
-#include <clang/AST/StmtVisitor.h>
-#include <clang/AST/ParentMap.h>
-#include <clang/Analysis/CFGStmtMap.h>
-#include <clang/Analysis/CallGraph.h>
-#include <llvm/Support/SaveAndRestore.h>
-#include <clang/StaticAnalyzer/Core/PathSensitive/AnalysisManager.h>
-#include <clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h>
 #include <clang/StaticAnalyzer/Core/Checker.h>
-#include <clang/StaticAnalyzer/Core/BugReporter/BugReporter.h>
+#include <clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h>
 #include <clang/StaticAnalyzer/Core/BugReporter/BugType.h>
-#include <llvm/ADT/SmallString.h>
 
 #include "CmsException.h"
 #include "CmsSupport.h"

Utilities/StaticAnalyzers/src/GlobalStaticChecker.cpp

@@ -27,10 +27,11 @@ void GlobalStaticChecker::checkASTDecl(const clang::VarDecl *D,
 
 	    if ( ! m_exception.reportGlobalStaticForType( t, DLoc, BR ) )
 		   return;
+	    if ( support::isSafeClassName( D->getCanonicalDecl()->getQualifiedNameAsString() ) ) return;
 
 	    std::string buf;
 	    llvm::raw_string_ostream os(buf);
-	    os << "Non-const variable '" << *D << "' is static and might be thread-unsafe";
+	    os << "Non-const variable '" << t.getAsString()<<" "<<*D << "' is static and might be thread-unsafe";
 
 	    BR.EmitBasicReport(D, "Possibly Thread-Unsafe: non-const static variable",
 	    					"ThreadSafety",

Utilities/StaticAnalyzers/src/MutableMemberChecker.cpp

@@ -5,7 +5,7 @@
 //===----------------------------------------------------------------------===//
 
 #include "MutableMemberChecker.h"
-
+using namespace clang;
 namespace clangcms {
 
 void MutableMemberChecker::checkASTDecl(const clang::FieldDecl *D,
@@ -21,11 +21,11 @@ void MutableMemberChecker::checkASTDecl(const clang::FieldDecl *D,
 
 	    if ( ! m_exception.reportMutableMember( t, DLoc, BR ) )
 		return;
-
+	    if ( support::isSafeClassName( t.getAsString() ) ) return;
+	    if ( ! support::isDataClass( D->getParent()->getQualifiedNameAsString() ) ) return;
 	    std::string buf;
 	    llvm::raw_string_ostream os(buf);
-	    os << "Mutable member'" << *D << "' in class, might be thread-unsafe when accessing via a const handle.";
-
+	    os << "Mutable member'" <<t.getAsString()<<" "<<*D << "' in class '"<<D->getParent()->getQualifiedNameAsString()<<"', might be thread-unsafe when accessing via a const handle.";
 	    BR.EmitBasicReport(D, "Possibly Thread-Unsafe: Mutable member",
 	    					"ThreadSafety",
 	                       os.str(), DLoc);

Utilities/StaticAnalyzers/src/MutableMemberChecker.h

@@ -12,6 +12,7 @@
 #include <clang/StaticAnalyzer/Core/BugReporter/BugType.h>
 
 #include "CmsException.h"
+#include "CmsSupport.h"
 
 namespace clangcms {
 class MutableMemberChecker : public clang::ento::Checker< clang::ento::check::ASTDecl< clang::FieldDecl> > {

Utilities/StaticAnalyzers/src/StaticLocalChecker.cpp

@@ -24,12 +24,17 @@ void StaticLocalChecker::checkASTDecl(const clang::VarDecl *D,
 
 	    if ( ! m_exception.reportGlobalStaticForType( t, DLoc, BR ) )
 			return;
+	    std::string vname = D->getCanonicalDecl()->getQualifiedNameAsString();
+	    unsigned found = vname.find_last_of("::");
+	    std::string cname = vname.substr(0,found);
+//	    if ( ! support::isDataClass( cname) ) return;
+	    if ( support::isSafeClassName( vname ) ) return;
 
 	    std::string buf;
 	    llvm::raw_string_ostream os(buf);
-	    os << "Non-const variable '" << *D << "' is local static and might be thread-unsafe";
+	    os << "Non-const variable '" <<t.getAsString()<<" "<< *D << "' is static local or static member data and might be thread-unsafe";
 
-	    BR.EmitBasicReport(D, "Possibly Thread-Unsafe: non-const static local variable",
+	    BR.EmitBasicReport(D, "Possibly Thread-Unsafe: non-const static variable",
 	    					"ThreadSafety",
 	                       os.str(), DLoc);
 	    return;