OpenTTD Source: src/debug.h Source File

OpenTTD Source 15.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_OPT__(,) __VA_ARGS__)); } while (false)
38void DebugPrint(const char *category, int level, const std::string &message);
39
40extern int _debug_driver_level;
41extern int _debug_grf_level;
42extern int _debug_map_level;
43extern int _debug_misc_level;
44extern int _debug_net_level;
45extern int _debug_sprite_level;
46extern int _debug_oldloader_level;
47extern int _debug_yapf_level;
48extern int _debug_fontcache_level;
49extern int _debug_script_level;
50extern int _debug_sl_level;
51extern int _debug_gamelog_level;
52extern int _debug_desync_level;
53extern int _debug_console_level;
54#ifdef RANDOM_DEBUG
55extern int _debug_random_level;
56#endif
57
58void DumpDebugFacilityNames(std::back_insert_iterator<std::string> &output_iterator);
59void SetDebugString(const char *s, void (*error_func)(const std::string &));
60std::string GetDebugString();
61
68 struct TicToc {
70 struct State {
71 const std::string_view name;
72 const uint32_t max_count;
73 uint32_t count = 0;
74 uint64_t chrono_sum = 0;
75
76 constexpr State(std::string_view name, uint32_t max_count) : name(name), max_count(max_count) { }
77 };
78
79 State &state;
80 std::chrono::high_resolution_clock::time_point chrono_start;
81
82 inline TicToc(State &state) : state(state), chrono_start(std::chrono::high_resolution_clock::now()) { }
83
84 inline ~TicToc()
85 {
86 this->state.chrono_sum += (std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::high_resolution_clock::now() - this->chrono_start)).count();
87 if (++this->state.count == this->state.max_count) {
88 Debug(misc, 0, "[{}] {} us [avg: {:.1f} us]", this->state.name, this->state.chrono_sum, this->state.chrono_sum / static_cast<double>(this->state.count));
89 this->state.count = 0;
90 this->state.chrono_sum = 0;
91 }
92 }
93};
94
95void ShowInfoI(const std::string &str);
96#define ShowInfo(format_string, ...) ShowInfoI(fmt::format(FMT_STRING(format_string) __VA_OPT__(,) __VA_ARGS__))
97
98std::string GetLogPrefix(bool force = false);
99
100void DebugSendRemoteMessages();
101void DebugReconsiderSendRemoteMessages();
102
103#endif /* DEBUG_H */
cpu.h
Functions related to CPU specific instructions.
Debug
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
Definition debug.h:37
DebugPrint
void DebugPrint(const char *category, int level, const std::string &message)
Internal function for outputting the debug line.
Definition debug.cpp:109
DebugReconsiderSendRemoteMessages
void DebugReconsiderSendRemoteMessages()
Reconsider whether we need to send debug messages to either NetworkAdminConsole or IConsolePrint.
Definition debug.cpp:264
SetDebugString
void SetDebugString(const char *s, void(*error_func)(const std::string &))
Set debugging levels by parsing the text in s.
Definition debug.cpp:143
GetLogPrefix
std::string GetLogPrefix(bool force=false)
Get the prefix for logs.
Definition debug.cpp:224
DumpDebugFacilityNames
void DumpDebugFacilityNames(std::back_insert_iterator< std::string > &output_iterator)
Dump the available debug facility names in the help text.
Definition debug.cpp:87
GetDebugString
std::string GetDebugString()
Print out the current debug-level.
Definition debug.cpp:206
DebugSendRemoteMessages
void DebugSendRemoteMessages()
Send the queued Debug messages to either NetworkAdminConsole or IConsolePrint from the GameLoop threa...
Definition debug.cpp:240
format.hpp
String formatting functions and helpers.
TicToc::State
Persistent state for TicToc profiling.
Definition debug.h:70
TicToc
TicToc profiling.
Definition debug.h:68
TicToc::chrono_start
std::chrono::high_resolution_clock::time_point chrono_start
real time count.
Definition debug.h:80