OpenTTD Source: src/debug.h Source File

OpenTTD Source 15.0-RC2

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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
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(std::string_view category, int level, 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);
59using SetDebugStringErrorFunc = void(std::string_view);
60void SetDebugString(std::string_view s, SetDebugStringErrorFunc error_func);
61std::string GetDebugString();
62
74 struct TicToc {
76 struct State {
77 const std::string_view name;
78 const std::optional<uint32_t> max_count;
79 uint32_t count = 0;
80 uint64_t chrono_sum = 0;
81
82 using States = std::vector<State *>;
83
84 State(std::string_view name, std::optional<uint32_t> max_count = {}) : name(name), max_count(max_count)
85 {
86 GetStates().push_back(this);
87 }
88
89 ~State()
90 {
91 /* Container might be already destroyed. */
92 if (!GetStates().empty()) std::erase(GetStates(), this);
93 }
94
95 static States &GetStates()
96 {
97 thread_local static States s_states;
98 return s_states;
99 }
100
101 void OutputAndReset(const std::string_view prefix = "")
102 {
103 Debug(misc, 0, "[{}] [{}] {} calls in {} us [avg: {:.1f} us]", prefix, this->name, this->count, this->chrono_sum, this->chrono_sum / static_cast<double>(this->count));
104 this->count = 0;
105 this->chrono_sum = 0;
106 }
107 };
108
109 State &state;
110 std::chrono::high_resolution_clock::time_point chrono_start;
111
112 inline TicToc(State &state) : state(state), chrono_start(std::chrono::high_resolution_clock::now()) { }
113
114 inline ~TicToc()
115 {
116 this->state.chrono_sum += (std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::high_resolution_clock::now() - this->chrono_start)).count();
117 this->state.count++;
118 if (this->state.max_count.has_value() && this->state.count == this->state.max_count.value()) {
119 this->state.OutputAndReset("MaxCount");
120 }
121 }
122
123 static void Tick(const std::string_view prefix)
124 {
125 for (auto state : State::GetStates()) {
126 if (state->max_count.has_value() || state->count == 0) continue;
127 state->OutputAndReset(prefix);
128 }
129 }
130};
131
132void ShowInfoI(std::string_view str);
133#define ShowInfo(format_string, ...) ShowInfoI(fmt::format(FMT_STRING(format_string) __VA_OPT__(,) __VA_ARGS__))
134
135std::string GetLogPrefix(bool force = false);
136
137void DebugSendRemoteMessages();
138void DebugReconsiderSendRemoteMessages();
139
140#endif /* DEBUG_H */
cpu.h
Functions related to CPU specific instructions.
Debug
#define Debug(category, level, format_string,...)
Output a line of debugging information.
Definition debug.h:37
SetDebugString
void SetDebugString(std::string_view s, SetDebugStringErrorFunc error_func)
Set debugging levels by parsing the text in s.
Definition debug.cpp:144
DebugReconsiderSendRemoteMessages
void DebugReconsiderSendRemoteMessages()
Reconsider whether we need to send debug messages to either NetworkAdminConsole or IConsolePrint.
Definition debug.cpp:259
DebugPrint
void DebugPrint(std::string_view category, int level, std::string &&message)
Internal function for outputting the debug line.
Definition debug.cpp:110
GetLogPrefix
std::string GetLogPrefix(bool force=false)
Get the prefix for logs.
Definition debug.cpp:219
DumpDebugFacilityNames
void DumpDebugFacilityNames(std::back_insert_iterator< std::string > &output_iterator)
Dump the available debug facility names in the help text.
Definition debug.cpp:88
GetDebugString
std::string GetDebugString()
Print out the current debug-level.
Definition debug.cpp:201
DebugSendRemoteMessages
void DebugSendRemoteMessages()
Send the queued Debug messages to either NetworkAdminConsole or IConsolePrint from the GameLoop threa...
Definition debug.cpp:235
format.hpp
String formatting functions and helpers.
TicToc::State
Persistent state for TicToc profiling.
Definition debug.h:76
TicToc
TicToc profiling.
Definition debug.h:74
TicToc::chrono_start
std::chrono::high_resolution_clock::time_point chrono_start
real time count.
Definition debug.h:110