Generate basic function summaries

This commit is contained in:
Daniel Marjamäki 2020-12-19 19:02:42 +01:00
parent a770342593
commit 96caaedbd5
6 changed files with 150 additions and 0 deletions

View File

@ -896,6 +896,8 @@ int CppCheckExecutor::check_internal(CppCheck& cppcheck, int /*argc*/, const cha
} }
if (!settings.buildDir.empty()) { if (!settings.buildDir.empty()) {
settings.loadSummaries();
std::list<std::string> fileNames; std::list<std::string> fileNames;
for (std::map<std::string, std::size_t>::const_iterator i = mFiles.begin(); i != mFiles.end(); ++i) for (std::map<std::string, std::size_t>::const_iterator i = mFiles.begin(); i != mFiles.end(); ++i)
fileNames.emplace_back(i->first); fileNames.emplace_back(i->first);

View File

@ -20,6 +20,8 @@
#include "valueflow.h" #include "valueflow.h"
#include <fstream>
std::atomic<bool> Settings::mTerminated; std::atomic<bool> Settings::mTerminated;
const char Settings::SafeChecks::XmlRootName[] = "safe-checks"; const char Settings::SafeChecks::XmlRootName[] = "safe-checks";
@ -155,3 +157,48 @@ bool Settings::isEnabled(const ValueFlow::Value *value, bool inconclusiveCheck)
return false; return false;
return true; return true;
} }
static std::vector<std::string> getSummaryFiles(const std::string &filename)
{
std::vector<std::string> ret;
std::ifstream fin(filename);
if (!fin.is_open())
return ret;
std::string line;
while (std::getline(fin, line)) {
std::string::size_type dotA = line.find(".a");
std::string::size_type colon = line.find(":");
if (colon > line.size() || dotA > colon)
continue;
std::string f = line.substr(0,colon);
f[dotA + 1] = 's';
ret.push_back(f);
}
return ret;
}
void Settings::loadSummaries()
{
if (buildDir.empty())
return;
std::vector<std::string> summaryFiles = getSummaryFiles(buildDir + "/files.txt");
for (const std::string &filename: summaryFiles) {
std::ifstream fin(buildDir + '/' + filename);
if (!fin.is_open())
continue;
std::string line;
while (std::getline(fin, line)) {
// Get function name
const std::string::size_type pos1 = 0;
const std::string::size_type pos2 = line.find(" ", pos1);
const std::string functionName = (pos2 == std::string::npos) ? line : line.substr(0, pos2);
// noreturn..
if (line.find(" noreturn:[") != std::string::npos || line.find(" call:[") != std::string::npos)
summaryNoreturn[functionName] = true;
else if (summaryNoreturn.find(functionName) == summaryNoreturn.end())
summaryNoreturn[functionName] = false;
}
}
}

View File

@ -415,6 +415,11 @@ public:
static bool terminated() { static bool terminated() {
return Settings::mTerminated; return Settings::mTerminated;
} }
std::map<std::string, bool> summaryNoreturn;
void loadSummaries();
}; };
/// @} /// @}

View File

@ -19,6 +19,7 @@
//--------------------------------------------------------------------------- //---------------------------------------------------------------------------
#include "tokenize.h" #include "tokenize.h"
#include "analyzerinfo.h"
#include "check.h" #include "check.h"
#include "errorlogger.h" #include "errorlogger.h"
#include "library.h" #include "library.h"
@ -2377,6 +2378,9 @@ bool Tokenizer::simplifyTokens1(const std::string &configuration)
mSymbolDatabase->setValueTypeInTokenList(true); mSymbolDatabase->setValueTypeInTokenList(true);
} }
if (!mSettings->buildDir.empty())
createSummaries(configuration);
if (mTimerResults) { if (mTimerResults) {
Timer t("Tokenizer::simplifyTokens1::ValueFlow", mSettings->showtime, mTimerResults); Timer t("Tokenizer::simplifyTokens1::ValueFlow", mSettings->showtime, mTimerResults);
ValueFlow::setValues(&list, mSymbolDatabase, mErrorLogger, mSettings); ValueFlow::setValues(&list, mSymbolDatabase, mErrorLogger, mSettings);
@ -8720,6 +8724,11 @@ bool Tokenizer::isScopeNoReturn(const Token *endScopeToken, bool *unknown) const
{ {
std::string unknownFunc; std::string unknownFunc;
const bool ret = mSettings->library.isScopeNoReturn(endScopeToken,&unknownFunc); const bool ret = mSettings->library.isScopeNoReturn(endScopeToken,&unknownFunc);
if (!unknownFunc.empty()) {
const std::map<std::string, bool>::const_iterator it = mSettings->summaryNoreturn.find(unknownFunc);
if (it != mSettings->summaryNoreturn.end() && !it->second)
return false;
}
if (unknown) if (unknown)
*unknown = !unknownFunc.empty(); *unknown = !unknownFunc.empty();
if (!unknownFunc.empty() && mSettings->checkLibrary && mSettings->isEnabled(Settings::INFORMATION)) { if (!unknownFunc.empty() && mSettings->checkLibrary && mSettings->isEnabled(Settings::INFORMATION)) {
@ -12064,3 +12073,60 @@ bool Tokenizer::hasIfdef(const Token *start, const Token *end) const
return false; return false;
} }
std::string Tokenizer::createSummaries(const std::string &configuration) const
{
std::ostringstream ostr;
for (const Scope *scope : mSymbolDatabase->functionScopes) {
const Function *f = scope->function;
if (!f)
continue;
// Summarize function
std::set<std::string> noreturn;
std::set<std::string> globalVars;
std::set<std::string> calledFunctions;
for (const Token* tok = scope->bodyStart; tok != scope->bodyEnd; tok = tok->next()) {
if (tok->variable() && tok->variable()->isGlobal())
globalVars.insert(tok->variable()->name());
if (Token::Match(tok, "%name% (") && !Token::simpleMatch(tok->linkAt(1), ") {")) {
calledFunctions.insert(tok->str());
if (Token::simpleMatch(tok->linkAt(1), ") ; }"))
noreturn.insert(tok->str());
}
}
// Write summary for function
auto join = [](const std::set<std::string> &data) -> std::string {
std::string ret;
const char *sep = "";
for (std::string d: data)
{
ret += sep + d;
sep = ",";
}
return ret;
};
ostr << f->name();
if (!globalVars.empty())
ostr << " global:[" << join(globalVars) << "]";
if (!calledFunctions.empty())
ostr << " call:[" << join(calledFunctions) << "]";
if (!noreturn.empty())
ostr << " noreturn:[" << join(noreturn) << "]";
ostr << std::endl;
}
if (!mSettings->buildDir.empty()) {
std::string filename = AnalyzerInformation::getAnalyzerInfoFile(mSettings->buildDir, list.getSourceFilePath(), configuration);
std::string::size_type pos = filename.rfind(".a");
if (pos != std::string::npos) {
filename[pos+1] = 's';
std::ofstream fout(filename);
fout << ostr.str();
}
}
return ostr.str();
}

View File

@ -585,6 +585,8 @@ public:
bool hasIfdef(const Token *start, const Token *end) const; bool hasIfdef(const Token *start, const Token *end) const;
std::string createSummaries(const std::string &configuration) const;
private: private:
/** /**

View File

@ -520,6 +520,10 @@ private:
TEST_CASE(checkHeader1); TEST_CASE(checkHeader1);
TEST_CASE(removeExtraTemplateKeywords); TEST_CASE(removeExtraTemplateKeywords);
TEST_CASE(createSummaries1);
TEST_CASE(createSummariesGlobal);
TEST_CASE(createSummariesNoreturn);
} }
std::string tokenizeAndStringify(const char code[], bool simplify = false, bool expand = true, Settings::PlatformType platform = Settings::Native, const char* filename = "test.cpp", bool cpp11 = true) { std::string tokenizeAndStringify(const char code[], bool simplify = false, bool expand = true, Settings::PlatformType platform = Settings::Native, const char* filename = "test.cpp", bool cpp11 = true) {
@ -8749,6 +8753,30 @@ private:
const char expected2[] = "GridView :: Codim < 0 > :: Iterator it ; it = gv . begin < 0 > ( ) ;"; const char expected2[] = "GridView :: Codim < 0 > :: Iterator it ; it = gv . begin < 0 > ( ) ;";
ASSERT_EQUALS(expected2, tokenizeAndStringify(code2, false)); ASSERT_EQUALS(expected2, tokenizeAndStringify(code2, false));
} }
std::string createSummaries(const char code[], const char filename[] = "test.cpp") {
// Clear the error buffer..
errout.str("");
// tokenize..
Settings settings;
Tokenizer tokenizer(&settings, this);
std::istringstream istr(code);
tokenizer.tokenize(istr, filename);
return tokenizer.createSummaries("");
}
void createSummaries1() {
ASSERT_EQUALS("foo\n", createSummaries("void foo() {}"));
}
void createSummariesGlobal() {
ASSERT_EQUALS("foo global:[x]\n", createSummaries("int x; void foo() { x=0; }"));
}
void createSummariesNoreturn() {
ASSERT_EQUALS("foo call:[bar] noreturn:[bar]\n", createSummaries("void foo() { bar(); }"));
}
}; };
REGISTER_TEST(TestTokenizer) REGISTER_TEST(TestTokenizer)