OpenTTD Source: src/debug.h Source File

OpenTTD Source 14.0-beta1

debug.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #ifndef DEBUG_H
11 #define DEBUG_H
12
13 #include "cpu.h"
14 #include <chrono>
15 #include "core/format.hpp"
16
17 /* Debugging messages policy:
18 * These should be the severities used for direct Debug() calls
19 * maximum debugging level should be 10 if really deep, deep
20 * debugging is needed.
21 * (there is room for exceptions, but you have to have a good cause):
22 * 0 - errors or severe warnings
23 * 1 - other non-fatal, non-severe warnings
24 * 2 - crude progress indicator of functionality
25 * 3 - important debugging messages (function entry)
26 * 4 - debugging messages (crude loop status, etc.)
27 * 5 - detailed debugging information
28 * 6.. - extremely detailed spamming
29 */
30
37 #define Debug(category, level, format_string, ...) do { if ((level) == 0 || _debug_ ## category ## _level >= (level)) DebugPrint(#category, level, fmt::format(FMT_STRING(format_string), ## __VA_ARGS__)); } while (false)
38 void DebugPrint(const char *category, int level, const std::string &message);
39
40 extern int _debug_driver_level;
41 extern int _debug_grf_level;
42 extern int _debug_map_level;
43 extern int _debug_misc_level;
44 extern int _debug_net_level;
45 extern int _debug_sprite_level;
46 extern int _debug_oldloader_level;
47 extern int _debug_npf_level;
48 extern int _debug_yapf_level;
49 extern int _debug_fontcache_level;
50 extern int _debug_script_level;
51 extern int _debug_sl_level;
52 extern int _debug_gamelog_level;
53 extern int _debug_desync_level;
54 extern int _debug_console_level;
55 #ifdef RANDOM_DEBUG
56 extern int _debug_random_level;
57 #endif
58
59 void DumpDebugFacilityNames(std::back_insert_iterator<std::string> &output_iterator);
60 void SetDebugString(const char *s, void (*error_func)(const std::string &));
61 std::string GetDebugString();
62
63 /* Shorter form for passing filename and linenumber */
64 #define FILE_LINE __FILE__, __LINE__
65
72 struct TicToc {
74 struct State {
75 const std::string_view name;
76 const uint32_t max_count;
77 uint32_t count = 0;
78 uint64_t chrono_sum = 0;
79
80 constexpr State(std::string_view name, uint32_t max_count) : name(name), max_count(max_count) { }
81 };
82
83 State &state;
84 std::chrono::high_resolution_clock::time_point chrono_start;
85
86 inline TicToc(State &state) : state(state), chrono_start(std::chrono::high_resolution_clock::now()) { }
87
88 inline ~TicToc()
89 {
90 this->state.chrono_sum += (std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::high_resolution_clock::now() - this->chrono_start)).count();
91 if (++this->state.count == this->state.max_count) {
92 Debug(misc, 0, "[{}] {} us [avg: {:.1f} us]", this->state.name, this->state.chrono_sum, this->state.chrono_sum / static_cast<double>(this->state.count));
93 this->state.count = 0;
94 this->state.chrono_sum = 0;
95 }
96 }
97 };
98
99 void ShowInfoI(const std::string &str);
100 #define ShowInfo(format_string, ...) ShowInfoI(fmt::format(FMT_STRING(format_string), ## __VA_ARGS__))
101
102 std::string GetLogPrefix(bool force = false);
103
104 void DebugSendRemoteMessages();
105 void DebugReconsiderSendRemoteMessages();
106
107 #endif /* DEBUG_H */
GetDebugString
std::string GetDebugString()
Print out the current debug-level.
Definition: debug.cpp:210
GetLogPrefix
std::string GetLogPrefix(bool force=false)
Get the prefix for logs.
Definition: debug.cpp:228
TicToc::chrono_start
std::chrono::high_resolution_clock::time_point chrono_start
real time count.
Definition: debug.h:84
format.hpp
DumpDebugFacilityNames
void DumpDebugFacilityNames(std::back_insert_iterator< std::string > &output_iterator)
Dump the available debug facility names in the help text.
Definition: debug.cpp:89
Debug
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
TicToc
TicToc profiling.
Definition: debug.h:72
TicToc::State
Persistent state for TicToc profiling.
Definition: debug.h:74
cpu.h
DebugReconsiderSendRemoteMessages
void DebugReconsiderSendRemoteMessages()
Reconsider whether we need to send debug messages to either NetworkAdminConsole or IConsolePrint.
Definition: debug.cpp:268
DebugSendRemoteMessages
void DebugSendRemoteMessages()
Send the queued Debug messages to either NetworkAdminConsole or IConsolePrint from the GameLoop threa...
Definition: debug.cpp:244
DebugPrint
void DebugPrint(const char *category, int level, const std::string &message)
Internal function for outputting the debug line.
Definition: debug.cpp:111
SetDebugString
void SetDebugString(const char *s, void(*error_func)(const std::string &))
Set debugging levels by parsing the text in s.
Definition: debug.cpp:145