walkero
/
cppcheck
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

optimized deserializing of `ErrorMessage` and related main process code (#4610)

This commit is contained in:
Oliver Stöneberg 2022-12-09 19:34:51 +01:00 committed by GitHub
parent bdee2ffc32
commit 40a69e5afb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 105 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
cli/filelister.cpp
View File

@ -210,15 +210,17 @@ static std::string addFiles2(std::map<std::string, std::size_t> &files,
// TODO: suppress instead?
(void)dir_result_buffer.buf; // do not trigger cppcheck itself on the "unused buf"
std::string new_path;
new_path.reserve(path.length() + 100);// prealloc some memory to avoid constant new/deletes in loop
new_path.reserve(path.length() + 1 + sizeof(dir_result->d_name));// prealloc some memory to avoid constant new/deletes in loop
new_path += path;
new_path += '/';
while ((SUPPRESS_DEPRECATED_WARNING(readdir_r(dir, &dir_result_buffer.entry, &dir_result)) == 0) && (dir_result != nullptr)) {
if ((std::strcmp(dir_result->d_name, ".") == 0) ||
(std::strcmp(dir_result->d_name, "..") == 0))
continue;
new_path = path + '/' + dir_result->d_name;
new_path.erase(path.length() + 1);
new_path += dir_result->d_name;
#if defined(_DIRENT_HAVE_D_TYPE) || defined(_BSD_SOURCE)
const bool path_is_directory = (dir_result->d_type == DT_DIR || (dir_result->d_type == DT_UNKNOWN && FileLister::isDirectory(new_path)));

125
lib/errorlogger.cpp
View File

@ -277,17 +277,17 @@ void ErrorMessage::deserialize(const std::string &data)
throw InternalError(nullptr, "Internal Error: Deserialization of error message failed - premature end of data");
std::string temp;
for (unsigned int i = 0; i < len && iss.good(); ++i) {
const char c = static_cast<char>(iss.get());
temp.append(1, c);
}
if (len > 0) {
temp.resize(len);
iss.read(&temp[0], len);
if (!iss.good())
throw InternalError(nullptr, "Internal Error: Deserialization of error message failed - premature end of data");
if (!iss.good())
throw InternalError(nullptr, "Internal Error: Deserialization of error message failed - premature end of data");
if (temp == "inconclusive") {
certainty = Certainty::inconclusive;
continue;
if (temp == "inconclusive") {
certainty = Certainty::inconclusive;
continue;
}
}
results[elem++] = temp;
@ -299,15 +299,32 @@ void ErrorMessage::deserialize(const std::string &data)
if (elem != 7)
throw InternalError(nullptr, "Internal Error: Deserialization of error message failed - insufficient elements");
id = results[0];
id = std::move(results[0]);
severity = Severity::fromString(results[1]);
if (!(std::istringstream(results[2]) >> cwe.id))
throw InternalError(nullptr, "Internal Error: Deserialization of error message failed - invalid CWE ID");
if (!(std::istringstream(results[3]) >> hash))
throw InternalError(nullptr, "Internal Error: Deserialization of error message failed - invalid hash");
file0 = results[4];
mShortMessage = results[5];
mVerboseMessage = results[6];
unsigned long long tmp = 0;
if (!results[2].empty()) {
try {
tmp = MathLib::toULongNumber(results[2]);
}
catch (const InternalError&) {
throw InternalError(nullptr, "Internal Error: Deserialization of error message failed - invalid CWE ID");
}
if (tmp > std::numeric_limits<unsigned short>::max())
throw InternalError(nullptr, "Internal Error: Deserialization of error message failed - CWE ID is out of range");
}
cwe.id = static_cast<unsigned short>(tmp);
hash = 0;
if (!results[3].empty()) {
try {
hash = MathLib::toULongNumber(results[3]);
}
catch (const InternalError&) {
throw InternalError(nullptr, "Internal Error: Deserialization of error message failed - invalid hash");
}
}
file0 = std::move(results[4]);
mShortMessage = std::move(results[5]);
mVerboseMessage = std::move(results[6]);
unsigned int stackSize = 0;
if (!(iss >> stackSize))
@ -324,14 +341,20 @@ void ErrorMessage::deserialize(const std::string &data)
if (!(iss >> len))
throw InternalError(nullptr, "Internal Error: Deserialization of error message failed - invalid length (stack)");
iss.get();
if (iss.get() != ' ')
throw InternalError(nullptr, "Internal Error: Deserialization of error message failed - invalid separator (stack)");
std::string temp;
for (unsigned int i = 0; i < len && iss.good(); ++i) {
const char c = static_cast<char>(iss.get());
temp.append(1, c);
if (len > 0) {
temp.resize(len);
iss.read(&temp[0], len);
if (!iss.good())
throw InternalError(nullptr, "Internal Error: Deserialization of error message failed - premature end of data (stack)");
}
std::vector<std::string> substrings;
substrings.reserve(5);
for (std::string::size_type pos = 0; pos < temp.size() && substrings.size() < 5; ++pos) {
if (substrings.size() == 4) {
substrings.push_back(temp.substr(pos));
@ -351,7 +374,7 @@ void ErrorMessage::deserialize(const std::string &data)
// (*loc).line << '\t' << (*loc).column << '\t' << (*loc).getfile(false) << '\t' << loc->getOrigFile(false) << '\t' << loc->getinfo();
ErrorMessage::FileLocation loc(substrings[3], MathLib::toLongNumber(substrings[0]), MathLib::toLongNumber(substrings[1]));
loc.setfile(substrings[2]);
loc.setfile(std::move(substrings[2]));
if (substrings.size() == 5)
loc.setinfo(substrings[4]);
@ -490,14 +513,22 @@ static std::string readCode(const std::string &file, int linenr, int column, con
static void replaceColors(std::string& source)
{
findAndReplace(source, "{reset}", ::toString(Color::Reset));
findAndReplace(source, "{bold}", ::toString(Color::Bold));
findAndReplace(source, "{dim}", ::toString(Color::Dim));
findAndReplace(source, "{red}", ::toString(Color::FgRed));
findAndReplace(source, "{green}", ::toString(Color::FgGreen));
findAndReplace(source, "{blue}", ::toString(Color::FgBlue));
findAndReplace(source, "{magenta}", ::toString(Color::FgMagenta));
findAndReplace(source, "{default}", ::toString(Color::FgDefault));
static const std::string reset_str = ::toString(Color::Reset);
findAndReplace(source, "{reset}", reset_str);
static const std::string bold_str = ::toString(Color::Bold);
findAndReplace(source, "{bold}", bold_str);
static const std::string dim_str = ::toString(Color::Dim);
findAndReplace(source, "{dim}", dim_str);
static const std::string red_str = ::toString(Color::FgRed);
findAndReplace(source, "{red}", red_str);
static const std::string green_str = ::toString(Color::FgGreen);
findAndReplace(source, "{green}", green_str);
static const std::string blue_str = ::toString(Color::FgBlue);
findAndReplace(source, "{blue}", blue_str);
static const std::string magenta_str = ::toString(Color::FgMagenta);
findAndReplace(source, "{magenta}", magenta_str);
static const std::string default_str = ::toString(Color::FgDefault);
findAndReplace(source, "{default}", default_str);
}
std::string ErrorMessage::toString(bool verbose, const std::string &templateFormat, const std::string &templateLocation) const
@ -506,17 +537,20 @@ std::string ErrorMessage::toString(bool verbose, const std::string &templateForm
// No template is given
if (templateFormat.empty()) {
std::ostringstream text;
if (!callStack.empty())
text << ErrorLogger::callStackToString(callStack) << ": ";
if (severity != Severity::none) {
text << '(' << Severity::toString(severity);
if (certainty == Certainty::inconclusive)
text << ", inconclusive";
text << ") ";
std::string text;
if (!callStack.empty()) {
text += ErrorLogger::callStackToString(callStack);
text += ": ";
}
text << (verbose ? mVerboseMessage : mShortMessage);
return text.str();
if (severity != Severity::none) {
text += '(';
text += Severity::toString(severity);
if (certainty == Certainty::inconclusive)
text += ", inconclusive";
text += ") ";
}
text += (verbose ? mVerboseMessage : mShortMessage);
return text;
}
// template is given. Reformat the output according to it
@ -542,8 +576,9 @@ std::string ErrorMessage::toString(bool verbose, const std::string &templateForm
findAndReplace(result, "{severity}", Severity::toString(severity));
findAndReplace(result, "{cwe}", MathLib::toString(cwe.id));
findAndReplace(result, "{message}", verbose ? mVerboseMessage : mShortMessage);
findAndReplace(result, "{callstack}", callStack.empty() ? emptyString : ErrorLogger::callStackToString(callStack));
if (!callStack.empty()) {
if (result.find("{callstack}") != std::string::npos)
findAndReplace(result, "{callstack}", ErrorLogger::callStackToString(callStack));
findAndReplace(result, "{file}", callStack.back().getfile());
findAndReplace(result, "{line}", MathLib::toString(callStack.back().line));
findAndReplace(result, "{column}", MathLib::toString(callStack.back().column));
@ -559,6 +594,7 @@ std::string ErrorMessage::toString(bool verbose, const std::string &templateForm
findAndReplace(result, "{code}", readCode(callStack.back().getOrigFile(), callStack.back().line, callStack.back().column, endl));
}
} else {
findAndReplace(result, "{callstack}", emptyString);
findAndReplace(result, "{file}", "nofile");
findAndReplace(result, "{line}", "0");
findAndReplace(result, "{column}", "0");
@ -663,11 +699,10 @@ std::string ErrorMessage::FileLocation::getOrigFile(bool convert) const
return mOrigFileName;
}
void ErrorMessage::FileLocation::setfile(const std::string &file)
void ErrorMessage::FileLocation::setfile(std::string file)
{
mFileName = file;
mFileName = Path::fromNativeSeparators(mFileName);
mFileName = Path::simplifyPath(mFileName);
mFileName = Path::fromNativeSeparators(std::move(file));
mFileName = Path::simplifyPath(std::move(mFileName));
}
std::string ErrorMessage::FileLocation::stringify() const

2
lib/errorlogger.h
View File

@ -84,7 +84,7 @@ public:
* Set the filename.
* @param file Filename to set.
*/
void setfile(const std::string &file);
void setfile(std::string file);
/**
* @return the location as a string. Format: [file:line]

4
lib/preprocessor.cpp
View File

@ -842,10 +842,10 @@ void Preprocessor::missingInclude(const std::string &filename, unsigned int line
if (!mSettings.checks.isEnabled(Checks::missingInclude) && !mSettings.checkConfiguration)
return;
const std::string fname = Path::fromNativeSeparators(filename);
std::string fname = Path::fromNativeSeparators(filename);
Suppressions::ErrorMessage errorMessage;
errorMessage.errorId = "missingInclude";
errorMessage.setFileName(fname);
errorMessage.setFileName(std::move(fname));
errorMessage.lineNumber = linenr;
if (mSettings.nomsg.isSuppressed(errorMessage))
return;

4
lib/suppressions.cpp
View File

@ -268,9 +268,9 @@ std::string Suppressions::addSuppressions(const std::list<Suppression> &suppress
return "";
}
void Suppressions::ErrorMessage::setFileName(const std::string &s)
void Suppressions::ErrorMessage::setFileName(std::string s)
{
mFileName = Path::simplifyPath(s);
mFileName = Path::simplifyPath(std::move(s));
}
bool Suppressions::Suppression::parseComment(std::string comment, std::string *errorMessage)

2
lib/suppressions.h
View File

@ -42,7 +42,7 @@ public:
struct CPPCHECKLIB ErrorMessage {
std::size_t hash;
std::string errorId;
void setFileName(const std::string &s);
void setFileName(std::string s);
const std::string &getFileName() const {
return mFileName;
}

2
lib/utils.cpp
View File

@ -56,7 +56,7 @@ bool matchglob(const std::string& pattern, const std::string& name)
{
const char* p = pattern.c_str();
const char* n = name.c_str();
std::stack<std::pair<const char*, const char*>> backtrack;
std::stack<std::pair<const char*, const char*>, std::vector<std::pair<const char*, const char*>>> backtrack;
for (;;) {
bool matching = true;

13
test/testerrorlogger.cpp
View File

@ -356,6 +356,19 @@ private:
ErrorMessage msg;
ASSERT_THROW_EQUALS(msg.deserialize(str), InternalError, "Internal Error: Deserialization of error message failed - invalid hash");
}
{
// out-of-range CWE ID
const char str[] = "7 errorId"
"5 error"
"5 65536" // max +1
"1 0"
"8 test.cpp"
"17 Programming error"
"17 Programming error"
"0 ";
ErrorMessage msg;
ASSERT_THROW(msg.deserialize(str), InternalError);
}
}
void SerializeSanitize() const {