Add sectioned scoped timer #864
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Change ScopedTimer from using deprecated boost::timer to using boost::chrono. The deprecated boost::timer was a wall clock on Windows and a POSIX clock on POSIX machines. boost::chrono is interchangeable with the std::chrono supported in C++11. I chose not to upgrade to the newer boost::timer implementation. The new boost::timer uses a non-standard duration representation and implies in the documentation that in future it will upgrade to chrono.
In order to produce output with ScopedTimer either always_output or verbose-logging has to be true. Change always_output to enable_output to better reflect its meaning.
A variable threshold is useful for profiling functions for which the 1 ms default is inappropriate.
SectionedScopedTimer works like ScopedTimer and it has a member function EnterSection(name) which starts a new sub section timer. When SectionedScopedTimer is destroyer it prints a table of the elapsed time of each section and the whole timer. Only one subsection timer is active at a time. Subsection can be re-entered.
| std::string m_name; | ||
| bool m_always_output; | ||
|
|
||
| void FormatDuration(std::stringstream &ss, const boost::chrono::nanoseconds & duration) { |
1. Style.
|
I've made the changes. |
Vezzra
added
the
category:refactoring
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR does three things:
ScopedTimera parameter of the constructorSectionedScopedTimeras aScopedTimerwith separately timed sub-sections.SectionedScopedTimerinMapWnd::InitTurn()as an example.SectionedScopedTimeris aScopedTimerwith an additional member functionEnterSection(<section name>), which creates/re-enters a separately timed sub section, with an arbitrary name.When
SectionedScopedTimergoes out of scope and is destroyed it prints a table of times. The table includes its total time and the time of any subsections that exceed the threshold parameter.An example table looks like this:
SectionedScopedTimer was the profiling tool that I used while working on the split fleet timing PR #863. I stripped it out of that PR to submit here separately.