OpenTTD Source: src/debug.h Source File

OpenTTD Source 13.1

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 "3rdparty/fmt/format.h"
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(name, level, format_string, ...) if ((level) == 0 || _debug_ ## name ## _level >= (level)) DebugPrint(#name, fmt::format(FMT_STRING(format_string), ## __VA_ARGS__))
38 void DebugPrint(const char *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 char *DumpDebugFacilityNames(char *buf, char *last);
60 void SetDebugString(const char *s, void (*error_func)(const char *));
61 const char *GetDebugString();
62
63 /* Shorter form for passing filename and linenumber */
64 #define FILE_LINE __FILE__, __LINE__
65
66 /* Used for profiling
67 *
68 * Usage:
69 * TIC();
70 * --Do your code--
71 * TOC("A name", 1);
72 *
73 * When you run the TIC() / TOC() multiple times, you can increase the '1'
74 * to only display average stats every N values. Some things to know:
75 *
76 * for (int i = 0; i < 5; i++) {
77 * TIC();
78 * --Do your code--
79 * TOC("A name", 5);
80 * }
81 *
82 * Is the correct usage for multiple TIC() / TOC() calls.
83 *
84 * TIC() / TOC() creates its own block, so make sure not the mangle
85 * it with another block.
86 *
87 * The output is counted in CPU cycles, and not comparable across
88 * machines. Mainly useful for local optimisations.
89 **/
90 #define TIC() {\
91 uint64 _xxx_ = ottd_rdtsc();\
92 static uint64 _sum_ = 0;\
93 static uint32 _i_ = 0;
94
95 #define TOC(str, count)\
96 _sum_ += ottd_rdtsc() - _xxx_;\
97 if (++_i_ == count) {\
98 Debug(misc, 0, "[{}] {} [avg: {:.1f}]", str, _sum_, _sum_/(double)_i_);\
99 _i_ = 0;\
100 _sum_ = 0;\
101 }\
102 }
103
104 /* Chrono based version. The output is in microseconds. */
105 #define TICC() {\
106 auto _start_ = std::chrono::high_resolution_clock::now();\
107 static uint64 _sum_ = 0;\
108 static uint32 _i_ = 0;
109
110 #define TOCC(str, _count_)\
111 _sum_ += (std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::high_resolution_clock::now() - _start_)).count();\
112 if (++_i_ == _count_) {\
113 Debug(misc, 0, "[{}] {} us [avg: {:.1f} us]", str, _sum_, _sum_/(double)_i_);\
114 _i_ = 0;\
115 _sum_ = 0;\
116 }\
117 }
118
119
120 void ShowInfo(const char *str);
121 void CDECL ShowInfoF(const char *str, ...) WARN_FORMAT(1, 2);
122
123 const char *GetLogPrefix();
124
125 void DebugSendRemoteMessages();
126 void DebugReconsiderSendRemoteMessages();
127
128 #endif /* DEBUG_H */
DebugPrint
void DebugPrint(const char *level, const std::string &message)
Internal function for outputting the debug line.
Definition: debug.cpp:117
SetDebugString
void SetDebugString(const char *s, void(*error_func)(const char *))
Set debugging levels by parsing the text in s.
Definition: debug.cpp:164
cpu.h
DebugReconsiderSendRemoteMessages
void DebugReconsiderSendRemoteMessages()
Reconsider whether we need to send debug messages to either NetworkAdminConsole or IConsolePrint.
Definition: debug.cpp:294
DebugSendRemoteMessages
void DebugSendRemoteMessages()
Send the queued Debug messages to either NetworkAdminConsole or IConsolePrint from the GameLoop threa...
Definition: debug.cpp:270
GetLogPrefix
void CDECL const char * GetLogPrefix()
Get the prefix for logs; if show_date_in_logs is enabled it returns the date, otherwise it returns no...
Definition: debug.cpp:252
DumpDebugFacilityNames
char * DumpDebugFacilityNames(char *buf, char *last)
Dump the available debug facility names in the help text.
Definition: debug.cpp:93
ShowInfoF
void CDECL ShowInfoF(const char *str,...)
Shows some information on the console/a popup box depending on the OS.
Definition: openttd.cpp:156
GetDebugString
const char * GetDebugString()
Print out the current debug-level.
Definition: debug.cpp:229