Skip to content

Commit 978a82e

Browse files
firewavefirewave
authored
refs #14599 - moved ShowTime logic out of timer-related code (#8493)
1 parent ba0b3a6 commit 978a82e

15 files changed

Lines changed: 104 additions & 117 deletions

‎Makefile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -695,7 +695,7 @@ $(libcppdir)/vfvalue.o: lib/vfvalue.cpp lib/config.h lib/errortypes.h lib/mathli
695695
frontend/frontend.o: frontend/frontend.cpp frontend/frontend.h lib/addoninfo.h lib/checkers.h lib/config.h lib/errortypes.h lib/filesettings.h lib/library.h lib/mathlib.h lib/path.h lib/platform.h lib/regex.h lib/settings.h lib/standards.h lib/utils.h
696696
$(CXX) ${INCLUDE_FOR_FE} $(CPPFLAGS) $(CXXFLAGS) -c -o $@ frontend/frontend.cpp
697697

698-
cli/cmdlineparser.o: cli/cmdlineparser.cpp cli/cmdlinelogger.h cli/cmdlineparser.h cli/filelister.h externals/tinyxml2/tinyxml2.h lib/addoninfo.h lib/check.h lib/checkers.h lib/color.h lib/config.h lib/cppcheck.h lib/errorlogger.h lib/errortypes.h lib/filesettings.h lib/importproject.h lib/library.h lib/mathlib.h lib/path.h lib/pathmatch.h lib/platform.h lib/regex.h lib/settings.h lib/standards.h lib/suppressions.h lib/timer.h lib/utils.h lib/xml.h
698+
cli/cmdlineparser.o: cli/cmdlineparser.cpp cli/cmdlinelogger.h cli/cmdlineparser.h cli/filelister.h externals/tinyxml2/tinyxml2.h lib/addoninfo.h lib/check.h lib/checkers.h lib/color.h lib/config.h lib/cppcheck.h lib/errorlogger.h lib/errortypes.h lib/filesettings.h lib/importproject.h lib/library.h lib/mathlib.h lib/path.h lib/pathmatch.h lib/platform.h lib/regex.h lib/settings.h lib/standards.h lib/suppressions.h lib/utils.h lib/xml.h
699699
$(CXX) ${INCLUDE_FOR_CLI} $(CPPFLAGS) $(CXXFLAGS) -c -o $@ cli/cmdlineparser.cpp
700700

701701
cli/cppcheckexecutor.o: cli/cppcheckexecutor.cpp cli/cmdlinelogger.h cli/cmdlineparser.h cli/cppcheckexecutor.h cli/executor.h cli/processexecutor.h cli/sehwrapper.h cli/signalhandler.h cli/singleexecutor.h cli/threadexecutor.h externals/picojson/picojson.h lib/addoninfo.h lib/analyzerinfo.h lib/check.h lib/checkers.h lib/checkersreport.h lib/color.h lib/config.h lib/cppcheck.h lib/errorlogger.h lib/errortypes.h lib/filesettings.h lib/json.h lib/library.h lib/mathlib.h lib/path.h lib/platform.h lib/regex.h lib/sarifreport.h lib/settings.h lib/standards.h lib/suppressions.h lib/timer.h lib/utils.h
@@ -776,7 +776,7 @@ test/testclangimport.o: test/testclangimport.cpp lib/addoninfo.h lib/check.h lib
776776
test/testclass.o: test/testclass.cpp lib/addoninfo.h lib/check.h lib/checkclass.h lib/checkers.h lib/color.h lib/config.h lib/ctu.h lib/errorlogger.h lib/errortypes.h lib/library.h lib/mathlib.h lib/path.h lib/platform.h lib/regex.h lib/settings.h lib/standards.h lib/tokenize.h lib/tokenlist.h lib/utils.h lib/vfvalue.h test/fixture.h test/helpers.h
777777
$(CXX) ${INCLUDE_FOR_TEST} ${CFLAGS_FOR_TEST} $(CPPFLAGS) $(CXXFLAGS) -c -o $@ test/testclass.cpp
778778

779-
test/testcmdlineparser.o: test/testcmdlineparser.cpp cli/cmdlinelogger.h cli/cmdlineparser.h lib/addoninfo.h lib/check.h lib/checkers.h lib/color.h lib/config.h lib/errorlogger.h lib/errortypes.h lib/filesettings.h lib/library.h lib/mathlib.h lib/path.h lib/platform.h lib/regex.h lib/settings.h lib/standards.h lib/suppressions.h lib/timer.h lib/tokenize.h lib/tokenlist.h lib/utils.h test/fixture.h test/helpers.h test/redirect.h
779+
test/testcmdlineparser.o: test/testcmdlineparser.cpp cli/cmdlinelogger.h cli/cmdlineparser.h lib/addoninfo.h lib/check.h lib/checkers.h lib/color.h lib/config.h lib/errorlogger.h lib/errortypes.h lib/filesettings.h lib/library.h lib/mathlib.h lib/path.h lib/platform.h lib/regex.h lib/settings.h lib/standards.h lib/suppressions.h lib/tokenize.h lib/tokenlist.h lib/utils.h test/fixture.h test/helpers.h test/redirect.h
780780
$(CXX) ${INCLUDE_FOR_TEST} ${CFLAGS_FOR_TEST} $(CPPFLAGS) $(CXXFLAGS) -c -o $@ test/testcmdlineparser.cpp
781781

782782
test/testcolor.o: test/testcolor.cpp lib/addoninfo.h lib/check.h lib/checkers.h lib/color.h lib/config.h lib/errorlogger.h lib/errortypes.h lib/library.h lib/mathlib.h lib/platform.h lib/regex.h lib/settings.h lib/standards.h lib/utils.h test/fixture.h

‎cli/cmdlineparser.cpp‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@
3636
#include "settings.h"
3737
#include "standards.h"
3838
#include "suppressions.h"
39-
#include "timer.h"
4039
#include "utils.h"
4140

4241
#include "frontend.h"
@@ -1430,17 +1429,17 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
14301429
else if (std::strncmp(argv[i], "--showtime=", 11) == 0) {
14311430
const std::string showtimeMode = argv[i] + 11;
14321431
if (showtimeMode == "file")
1433-
mSettings.showtime = ShowTime::FILE;
1432+
mSettings.showtime = Settings::ShowTime::FILE;
14341433
else if (showtimeMode == "file-total")
1435-
mSettings.showtime = ShowTime::FILE_TOTAL;
1434+
mSettings.showtime = Settings::ShowTime::FILE_TOTAL;
14361435
else if (showtimeMode == "summary")
1437-
mSettings.showtime = ShowTime::SUMMARY;
1436+
mSettings.showtime = Settings::ShowTime::SUMMARY;
14381437
else if (showtimeMode == "top5_file")
1439-
mSettings.showtime = ShowTime::TOP5_FILE;
1438+
mSettings.showtime = Settings::ShowTime::TOP5_FILE;
14401439
else if (showtimeMode == "top5_summary")
1441-
mSettings.showtime = ShowTime::TOP5_SUMMARY;
1440+
mSettings.showtime = Settings::ShowTime::TOP5_SUMMARY;
14421441
else if (showtimeMode == "none")
1443-
mSettings.showtime = ShowTime::NONE;
1442+
mSettings.showtime = Settings::ShowTime::NONE;
14441443
else if (showtimeMode.empty()) {
14451444
mLogger.printError("no mode provided for --showtime");
14461445
return Result::Fail;

‎cli/cppcheckexecutor.cpp‎

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
#include <iostream>
5757
#include <list>
5858
#include <map>
59+
#include <memory>
5960
#include <set>
6061
#include <sstream>
6162
#include <unordered_set>
@@ -268,8 +269,8 @@ int CppCheckExecutor::check(int argc, const char* const argv[])
268269
}
269270

270271
std::unique_ptr<OneShotTimer> overallTimer;
271-
if (settings.showtime == ShowTime::SUMMARY || settings.showtime == ShowTime::TOP5_SUMMARY)
272-
overallTimer.reset(new OneShotTimer("Overall time", settings.showtime));
272+
if (settings.showtime == Settings::ShowTime::SUMMARY || settings.showtime == Settings::ShowTime::TOP5_SUMMARY)
273+
overallTimer.reset(new OneShotTimer("Overall time"));
273274

274275
settings.loadSummaries();
275276

@@ -420,7 +421,9 @@ bool CppCheckExecutor::reportUnmatchedSuppressions(const Settings &settings, con
420421
int CppCheckExecutor::check_internal(const Settings& settings, Suppressions& supprs) const
421422
{
422423
StdLogger stdLogger(settings);
423-
TimerResults timerResults;
424+
std::unique_ptr<TimerResults> timerResults;
425+
if (settings.showtime != Settings::ShowTime::NONE)
426+
timerResults.reset(new TimerResults);
424427

425428
if (settings.reportProgress >= 0)
426429
stdLogger.resetLatestProgressOutputTime();
@@ -441,31 +444,35 @@ int CppCheckExecutor::check_internal(const Settings& settings, Suppressions& sup
441444
if (!settings.checkersReportFilename.empty())
442445
std::remove(settings.checkersReportFilename.c_str());
443446

444-
CppCheck cppcheck(settings, supprs, stdLogger, &timerResults, true, executeCommand);
447+
CppCheck cppcheck(settings, supprs, stdLogger, timerResults.get(), true, executeCommand);
445448

446449
unsigned int returnValue = 0;
447450
if (settings.useSingleJob()) {
448451
// Single process
449-
SingleExecutor executor(cppcheck, mFiles, mFileSettings, settings, supprs, stdLogger, &timerResults);
452+
SingleExecutor executor(cppcheck, mFiles, mFileSettings, settings, supprs, stdLogger, timerResults.get());
450453
returnValue = executor.check();
451454
} else {
452455
#if defined(HAS_THREADING_MODEL_THREAD)
453456
if (settings.executor == Settings::ExecutorType::Thread) {
454-
ThreadExecutor executor(mFiles, mFileSettings, settings, supprs, stdLogger, &timerResults, CppCheckExecutor::executeCommand);
457+
ThreadExecutor executor(mFiles, mFileSettings, settings, supprs, stdLogger, timerResults.get(), CppCheckExecutor::executeCommand);
455458
returnValue = executor.check();
456459
}
457460
#endif
458461
#if defined(HAS_THREADING_MODEL_FORK)
459462
if (settings.executor == Settings::ExecutorType::Process) {
460-
ProcessExecutor executor(mFiles, mFileSettings, settings, supprs, stdLogger, &timerResults, CppCheckExecutor::executeCommand);
463+
ProcessExecutor executor(mFiles, mFileSettings, settings, supprs, stdLogger, timerResults.get(), CppCheckExecutor::executeCommand);
461464
returnValue = executor.check();
462465
}
463466
#endif
464467
}
465468

466469
// TODO: show time *after* the whole program analysis
467-
if (settings.showtime == ShowTime::SUMMARY || settings.showtime == ShowTime::TOP5_SUMMARY)
468-
timerResults.showResults(settings.showtime);
470+
if (timerResults) {
471+
if (settings.showtime == Settings::ShowTime::SUMMARY)
472+
timerResults->showResults();
473+
else if (settings.showtime == Settings::ShowTime::TOP5_SUMMARY)
474+
timerResults->showResults(5);
475+
}
469476

470477
// TODO: is this run again instead of using previously cached results?
471478
returnValue |= cppcheck.analyseWholeProgram(settings.buildDir, mFiles, mFileSettings, stdLogger.getCtuInfo());

‎lib/cppcheck.cpp‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -924,8 +924,8 @@ unsigned int CppCheck::checkInternal(const FileWithDetails& file, const std::str
924924
return mLogger->exitcode();
925925

926926
std::unique_ptr<OneShotTimer> checkTimeTimer;
927-
if (mSettings.showtime == ShowTime::FILE || mSettings.showtime == ShowTime::FILE_TOTAL || mSettings.showtime == ShowTime::TOP5_FILE)
928-
checkTimeTimer.reset(new OneShotTimer("Check time: " + file.spath(), mSettings.showtime));
927+
if (mSettings.showtime == Settings::ShowTime::FILE || mSettings.showtime == Settings::ShowTime::FILE_TOTAL || mSettings.showtime == Settings::ShowTime::TOP5_FILE)
928+
checkTimeTimer.reset(new OneShotTimer("Check time: " + file.spath()));
929929

930930
if (!mSettings.quiet) {
931931
std::string fixedpath = Path::toNativeSeparators(file.spath());
@@ -1045,7 +1045,7 @@ unsigned int CppCheck::checkInternal(const FileWithDetails& file, const std::str
10451045
// Get configurations..
10461046
std::set<std::string> configurations;
10471047
if (maxConfigs > 1) {
1048-
Timer::run("Preprocessor::getConfigs", mSettings.showtime, mTimerResults, [&]() {
1048+
Timer::run("Preprocessor::getConfigs", mTimerResults, [&]() {
10491049
configurations = preprocessor.getConfigs();
10501050
});
10511051
} else {
@@ -1130,7 +1130,7 @@ unsigned int CppCheck::checkInternal(const FileWithDetails& file, const std::str
11301130

11311131
if (mSettings.preprocessOnly) {
11321132
std::string codeWithoutCfg;
1133-
Timer::run("Preprocessor::getcode", mSettings.showtime, mTimerResults, [&]() {
1133+
Timer::run("Preprocessor::getcode", mTimerResults, [&]() {
11341134
codeWithoutCfg = preprocessor.getcode(currentConfig, files, true);
11351135
});
11361136

@@ -1154,7 +1154,7 @@ unsigned int CppCheck::checkInternal(const FileWithDetails& file, const std::str
11541154
{
11551155
bool skipCfg = false;
11561156
// Create tokens, skip rest of iteration if failed
1157-
Timer::run("Tokenizer::createTokens", mSettings.showtime, mTimerResults, [&]() {
1157+
Timer::run("Tokenizer::createTokens", mTimerResults, [&]() {
11581158
simplecpp::OutputList outputList_cfg;
11591159
simplecpp::TokenList tokensP = preprocessor.preprocess(currentConfig, files, outputList_cfg);
11601160
const simplecpp::Output* o = preprocessor.handleErrors(outputList_cfg);
@@ -1180,8 +1180,7 @@ unsigned int CppCheck::checkInternal(const FileWithDetails& file, const std::str
11801180

11811181
Tokenizer tokenizer(std::move(tokenlist), mErrorLogger);
11821182
try {
1183-
if (mSettings.showtime != ShowTime::NONE)
1184-
tokenizer.setTimerResults(mTimerResults);
1183+
tokenizer.setTimerResults(mTimerResults);
11851184
tokenizer.setDirectives(directives); // TODO: how to avoid repeated copies?
11861185

11871186
// locations macros
@@ -1294,8 +1293,12 @@ unsigned int CppCheck::checkInternal(const FileWithDetails& file, const std::str
12941293
// TODO: clear earlier?
12951294
mLogger->clear();
12961295

1297-
if (mTimerResults && (mSettings.showtime == ShowTime::FILE || mSettings.showtime == ShowTime::TOP5_FILE))
1298-
mTimerResults->showResults(mSettings.showtime);
1296+
if (mTimerResults) {
1297+
if (mSettings.showtime == Settings::ShowTime::FILE)
1298+
mTimerResults->showResults();
1299+
else if (mSettings.showtime == Settings::ShowTime::TOP5_FILE)
1300+
mTimerResults->showResults(5);
1301+
}
12991302

13001303
return mLogger->exitcode();
13011304
}
@@ -1354,7 +1357,7 @@ void CppCheck::checkNormalTokens(const Tokenizer &tokenizer, AnalyzerInformation
13541357
return;
13551358
}
13561359

1357-
Timer::run(check->name() + "::runChecks", mSettings.showtime, mTimerResults, [&]() {
1360+
Timer::run(check->name() + "::runChecks", mTimerResults, [&]() {
13581361
check->runChecks(tokenizer, &mErrorLogger);
13591362
});
13601363
}
@@ -1489,7 +1492,7 @@ void CppCheck::executeAddons(const std::string& dumpFile, const FileWithDetails&
14891492
{
14901493
if (!dumpFile.empty()) {
14911494
std::vector<std::string> f{dumpFile};
1492-
Timer::run("CppCheck::executeAddons", mSettings.showtime, mTimerResults, [&]() {
1495+
Timer::run("CppCheck::executeAddons", mTimerResults, [&]() {
14931496
executeAddons(f, file.spath());
14941497
});
14951498
}

‎lib/settings.h‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ class Regex;
5353
#endif
5454

5555
struct Suppressions;
56-
enum class ShowTime : std::uint8_t;
5756
namespace ValueFlow {
5857
class Value;
5958
}
@@ -442,6 +441,15 @@ class CPPCHECKLIB WARN_UNUSED Settings {
442441
SimpleEnableGroup<Certainty> certainty;
443442
SimpleEnableGroup<Checks> checks;
444443

444+
enum class ShowTime : std::uint8_t {
445+
NONE,
446+
FILE,
447+
FILE_TOTAL,
448+
SUMMARY,
449+
TOP5_SUMMARY,
450+
TOP5_FILE
451+
};
452+
445453
/** @brief show timing information (--showtime=file|summary|top5) */
446454
ShowTime showtime{};
447455

‎lib/timer.cpp‎

Lines changed: 16 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@
1919
#include "timer.h"
2020

2121
#include <algorithm>
22-
#include <cassert>
23-
#include <cstddef>
2422
#include <iostream>
2523
#include <utility>
2624
#include <vector>
@@ -38,12 +36,9 @@ namespace {
3836

3937
// TODO: this does not include any file context when SHOWTIME_FILE thus rendering it useless - should we include the logging with the progress logging?
4038
// that could also get rid of the broader locking
41-
void TimerResults::showResults(ShowTime mode, bool metrics) const
39+
void TimerResults::showResults(size_t max_results, bool metrics) const
4240
{
43-
if (mode == ShowTime::NONE)
44-
return;
4541
std::vector<dataElementType> data;
46-
4742
{
4843
std::lock_guard<std::mutex> l(mResultsSync);
4944

@@ -57,7 +52,7 @@ void TimerResults::showResults(ShowTime mode, bool metrics) const
5752

5853
size_t ordinal = 1; // maybe it would be nice to have an ordinal in output later!
5954
for (auto iter=data.cbegin(); iter!=data.cend(); ++iter) {
60-
if ((mode != ShowTime::TOP5_FILE && mode != ShowTime::TOP5_SUMMARY) || (ordinal<=5)) {
55+
if (ordinal <= max_results) {
6156
const double sec = iter->second.getSeconds().count();
6257
std::cout << iter->first << ": " << sec << "s";
6358
if (metrics) {
@@ -85,12 +80,14 @@ void TimerResults::reset()
8580
mResults.clear();
8681
}
8782

88-
Timer::Timer(std::string str, ShowTime showtimeMode, TimerResultsIntf* timerResults)
83+
Timer::Timer(std::string str, TimerResultsIntf* timerResults)
8984
: mName(std::move(str))
90-
, mMode(showtimeMode)
91-
, mStart(Clock::now())
9285
, mResults(timerResults)
93-
{}
86+
{
87+
if (!mResults)
88+
return;
89+
mStart = Clock::now();
90+
}
9491

9592
Timer::~Timer()
9693
{
@@ -99,18 +96,13 @@ Timer::~Timer()
9996

10097
void Timer::stop()
10198
{
102-
if (mMode == ShowTime::NONE)
99+
if (mStart == TimePoint{})
103100
return;
104-
if (mStart != TimePoint{}) {
105-
if (!mResults) {
106-
assert(false);
107-
}
108-
else {
109-
auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(Clock::now() - mStart);
110-
mResults->addResults(mName, diff);
111-
}
112-
}
113-
mMode = ShowTime::NONE; // prevent multiple stops
101+
102+
const auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(Clock::now() - mStart);
103+
mResults->addResults(mName, diff);
104+
105+
mStart = TimePoint{}; // prevent multiple stops
114106
}
115107

116108
static std::string durationToString(std::chrono::milliseconds duration)
@@ -138,11 +130,8 @@ static std::string durationToString(std::chrono::milliseconds duration)
138130
return (ellapsedTime + secondsStr + "s");
139131
}
140132

141-
OneShotTimer::OneShotTimer(std::string name, ShowTime showtime)
133+
OneShotTimer::OneShotTimer(std::string name)
142134
{
143-
if (showtime == ShowTime::NONE)
144-
return;
145-
146135
class MyResults : public TimerResultsIntf
147136
{
148137
private:
@@ -156,5 +145,5 @@ OneShotTimer::OneShotTimer(std::string name, ShowTime showtime)
156145
};
157146

158147
mResults.reset(new MyResults);
159-
mTimer.reset(new Timer(std::move(name), showtime, mResults.get()));
148+
mTimer.reset(new Timer(std::move(name), mResults.get()));
160149
}

‎lib/timer.h‎

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@
2323
#include "config.h"
2424

2525
#include <chrono>
26-
#include <cstdint>
26+
#include <cstddef>
27+
#include <limits>
2728
#include <map>
2829
#include <memory>
2930
#include <mutex>
@@ -32,15 +33,6 @@
3233
#include <utility>
3334
#include <vector>
3435

35-
enum class ShowTime : std::uint8_t {
36-
NONE,
37-
FILE,
38-
FILE_TOTAL,
39-
SUMMARY,
40-
TOP5_SUMMARY,
41-
TOP5_FILE
42-
};
43-
4436
class CPPCHECKLIB TimerResultsIntf {
4537
public:
4638
virtual ~TimerResultsIntf() = default;
@@ -66,7 +58,7 @@ class CPPCHECKLIB WARN_UNUSED TimerResults : public TimerResultsIntf {
6658
public:
6759
TimerResults() = default;
6860

69-
void showResults(ShowTime mode, bool metrics = true) const;
61+
void showResults(size_t max_results = std::numeric_limits<size_t>::max(), bool metrics = true) const;
7062
void addResults(const std::string& name, std::chrono::milliseconds duration) override;
7163

7264
void reset();
@@ -81,7 +73,7 @@ class CPPCHECKLIB Timer {
8173
using Clock = std::chrono::high_resolution_clock;
8274
using TimePoint = std::chrono::time_point<Clock>;
8375

84-
Timer(std::string str, ShowTime showtimeMode, TimerResultsIntf* timerResults = nullptr);
76+
explicit Timer(std::string str, TimerResultsIntf* timerResults = nullptr);
8577
~Timer();
8678

8779
Timer(const Timer&) = delete;
@@ -90,22 +82,21 @@ class CPPCHECKLIB Timer {
9082
void stop();
9183

9284
template<class TFunc>
93-
static void run(std::string str, ShowTime showtimeMode, TimerResultsIntf* timerResults, const TFunc& f) {
94-
Timer t(std::move(str), showtimeMode, timerResults);
85+
static void run(std::string str, TimerResultsIntf* timerResults, const TFunc& f) {
86+
Timer t(std::move(str), timerResults);
9587
f();
9688
}
9789

9890
private:
9991
const std::string mName;
100-
ShowTime mMode{};
10192
TimePoint mStart;
10293
TimerResultsIntf* mResults{};
10394
};
10495

10596
class CPPCHECKLIB OneShotTimer
10697
{
10798
public:
108-
OneShotTimer(std::string name, ShowTime showtime);
99+
explicit OneShotTimer(std::string name);
109100
private:
110101
std::unique_ptr<TimerResultsIntf> mResults;
111102
std::unique_ptr<Timer> mTimer;

0 commit comments

Comments
 (0)