OpenTTD Source: src/debug.h Source File

OpenTTD Source 1.11.0-RC1

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
16 /* Debugging messages policy:
17 * These should be the severities used for direct DEBUG() calls
18 * maximum debugging level should be 10 if really deep, deep
19 * debugging is needed.
20 * (there is room for exceptions, but you have to have a good cause):
21 * 0 - errors or severe warnings
22 * 1 - other non-fatal, non-severe warnings
23 * 2 - crude progress indicator of functionality
24 * 3 - important debugging messages (function entry)
25 * 4 - debugging messages (crude loop status, etc.)
26 * 5 - detailed debugging information
27 * 6.. - extremely detailed spamming
28 */
29
35 #define DEBUG(name, level, ...) if ((level) == 0 || _debug_ ## name ## _level >= (level)) debug(#name, __VA_ARGS__)
36
37 extern int _debug_driver_level;
38 extern int _debug_grf_level;
39 extern int _debug_map_level;
40 extern int _debug_misc_level;
41 extern int _debug_net_level;
42 extern int _debug_sprite_level;
43 extern int _debug_oldloader_level;
44 extern int _debug_npf_level;
45 extern int _debug_yapf_level;
46 extern int _debug_freetype_level;
47 extern int _debug_script_level;
48 extern int _debug_sl_level;
49 extern int _debug_gamelog_level;
50 extern int _debug_desync_level;
51 extern int _debug_console_level;
52 #ifdef RANDOM_DEBUG
53 extern int _debug_random_level;
54 #endif
55
56 void CDECL debug(const char *dbg, const char *format, ...) WARN_FORMAT(2, 3);
57
58 char *DumpDebugFacilityNames(char *buf, char *last);
59 void SetDebugString(const char *s);
60 const char *GetDebugString();
61
62 /* Shorter form for passing filename and linenumber */
63 #define FILE_LINE __FILE__, __LINE__
64
65 /* Used for profiling
66 *
67 * Usage:
68 * TIC();
69 * --Do your code--
70 * TOC("A name", 1);
71 *
72 * When you run the TIC() / TOC() multiple times, you can increase the '1'
73 * to only display average stats every N values. Some things to know:
74 *
75 * for (int i = 0; i < 5; i++) {
76 * TIC();
77 * --Do your code--
78 * TOC("A name", 5);
79 * }
80 *
81 * Is the correct usage for multiple TIC() / TOC() calls.
82 *
83 * TIC() / TOC() creates its own block, so make sure not the mangle
84 * it with another block.
85 *
86 * The output is counted in CPU cycles, and not comparable across
87 * machines. Mainly useful for local optimisations.
88 **/
89 #define TIC() {\
90 uint64 _xxx_ = ottd_rdtsc();\
91 static uint64 _sum_ = 0;\
92 static uint32 _i_ = 0;
93
94 #define TOC(str, count)\
95 _sum_ += ottd_rdtsc() - _xxx_;\
96 if (++_i_ == count) {\
97 DEBUG(misc, 0, "[%s] " OTTD_PRINTF64 " [avg: %.1f]", str, _sum_, _sum_/(double)_i_);\
98 _i_ = 0;\
99 _sum_ = 0;\
100 }\
101 }
102
103 /* Chrono based version. The output is in microseconds. */
104 #define TICC() {\
105 auto _start_ = std::chrono::high_resolution_clock::now();\
106 static uint64 _sum_ = 0;\
107 static uint32 _i_ = 0;
108
109 #define TOCC(str, _count_)\
110 _sum_ += (std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::high_resolution_clock::now() - _start_)).count();\
111 if (++_i_ == _count_) {\
112 DEBUG(misc, 0, "[%s] " OTTD_PRINTF64 " us [avg: %.1f us]", str, _sum_, _sum_/(double)_i_);\
113 _i_ = 0;\
114 _sum_ = 0;\
115 }\
116 }
117
118
119 void ShowInfo(const char *str);
120 void CDECL ShowInfoF(const char *str, ...) WARN_FORMAT(1, 2);
121
122 const char *GetLogPrefix();
123
124 #endif /* DEBUG_H */
debug
void CDECL debug(const char *dbg, const char *format,...)
Output a debug line.
Definition: debug.cpp:152
cpu.h
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:247
ShowInfoF
void CDECL ShowInfoF(const char *str,...)
Shows some information on the console/a popup box depending on the OS.
Definition: openttd.cpp:153
SetDebugString
void SetDebugString(const char *s)
Set debugging levels by parsing the text in s.
Definition: debug.cpp:170
DumpDebugFacilityNames
void CDECL char * DumpDebugFacilityNames(char *buf, char *last)
Dump the available debug facility names in the help text.
Definition: debug.cpp:82
GetDebugString
const char * GetDebugString()
Print out the current debug-level.
Definition: debug.cpp:224