Files
@ r28815:5e58b8dec74d
Branch filter:
Location: cpp/openttd-patchpack/source/src/debug.cpp - annotation
r28815:5e58b8dec74d
8.1 KiB
text/x-c
Codechange: Off-by-one in colour gradient initialisation.
Remap sprites start with a count byte followed by 256 entries, but
SetupColoursAndInitialWindow did not take account of this extra byte and
therefore started at palette index 0xC5 instead of 0xC6. This caused the
first colour of each gradient to be incorrect and all shades were actually
1 step lower in the gradient than indicated.
Remap sprites start with a count byte followed by 256 entries, but
SetupColoursAndInitialWindow did not take account of this extra byte and
therefore started at palette index 0xC5 instead of 0xC6. This caused the
first colour of each gradient to be incorrect and all shades were actually
1 step lower in the gradient than indicated.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 | r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r9111:983de9c5a848 r6125:eb40461cb765 r5584:545d748cc681 r9336:b3c601814650 r18882:b2227172c2cf r18882:b2227172c2cf r10515:c73815918fba r12984:b9c53ed05d55 r25942:fb8ed4e7ecae r12984:b9c53ed05d55 r23088:6710c4c79ac6 r22873:025d4805a116 r22873:025d4805a116 r22873:025d4805a116 r27418:86b1bec802f9 r5959:56b708e464d2 r16264:1f7e2ab6252c r5584:545d748cc681 r21383:942c32fb8b0e r21383:942c32fb8b0e r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r26399:db15b808f86d r18532:5a0e8241e328 r5584:545d748cc681 r9457:ecfeb802c57a r10515:c73815918fba r14498:ba88afbc611b r18988:3f7b98056f8d r18988:3f7b98056f8d r18988:3f7b98056f8d r5584:545d748cc681 r6248:b940b09d7ab8 r5584:545d748cc681 r5584:545d748cc681 r6248:b940b09d7ab8 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r26399:db15b808f86d r18532:5a0e8241e328 r5584:545d748cc681 r9457:ecfeb802c57a r10515:c73815918fba r14499:548a06b3ce78 r18988:3f7b98056f8d r18988:3f7b98056f8d r18988:3f7b98056f8d r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r19200:843e97bfe892 r19200:843e97bfe892 r27398:53658248e31b r19200:843e97bfe892 r27398:53658248e31b r19200:843e97bfe892 r27398:53658248e31b r19200:843e97bfe892 r27398:53658248e31b r27398:53658248e31b r19200:843e97bfe892 r27398:53658248e31b r19200:843e97bfe892 r28481:4df4e2dbb670 r27398:53658248e31b r19200:843e97bfe892 r27398:53658248e31b r27398:53658248e31b r19200:843e97bfe892 r19200:843e97bfe892 r19200:843e97bfe892 r16081:e554542808c8 r16081:e554542808c8 r25657:33b86bb7de01 r25657:33b86bb7de01 r16081:e554542808c8 r28620:953e949c2631 r5584:545d748cc681 r28620:953e949c2631 r18988:3f7b98056f8d r23607:36c15679007d r18988:3f7b98056f8d r28620:953e949c2631 r18988:3f7b98056f8d r18988:3f7b98056f8d r28620:953e949c2631 r18988:3f7b98056f8d r23607:36c15679007d r18988:3f7b98056f8d r27405:f68bba683a4b r18988:3f7b98056f8d r18988:3f7b98056f8d r18988:3f7b98056f8d r28620:953e949c2631 r25661:2509fe7b65ed r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r28620:953e949c2631 r25942:fb8ed4e7ecae r5584:545d748cc681 r5584:545d748cc681 r9457:ecfeb802c57a r16081:e554542808c8 r16081:e554542808c8 r16081:e554542808c8 r16081:e554542808c8 r16081:e554542808c8 r26342:d8dee617c9b0 r16081:e554542808c8 r27147:5d938ed2c7b5 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r26343:f42ba508ac7f r26343:f42ba508ac7f r26343:f42ba508ac7f r26343:f42ba508ac7f r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r27168:197e090a03f4 r5584:545d748cc681 r5584:545d748cc681 r26343:f42ba508ac7f r26343:f42ba508ac7f r26343:f42ba508ac7f r5584:545d748cc681 r5584:545d748cc681 r26343:f42ba508ac7f r5584:545d748cc681 r6125:eb40461cb765 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r6125:eb40461cb765 r26343:f42ba508ac7f r26343:f42ba508ac7f r5584:545d748cc681 r26343:f42ba508ac7f r5584:545d748cc681 r5584:545d748cc681 r15542:f6c6d0f8689e r5584:545d748cc681 r5584:545d748cc681 r27168:197e090a03f4 r5584:545d748cc681 r26343:f42ba508ac7f r26343:f42ba508ac7f r5584:545d748cc681 r26342:d8dee617c9b0 r27147:5d938ed2c7b5 r5584:545d748cc681 r5584:545d748cc681 r5584:545d748cc681 r26343:f42ba508ac7f r26343:f42ba508ac7f r26343:f42ba508ac7f r26343:f42ba508ac7f r26343:f42ba508ac7f r26343:f42ba508ac7f r26343:f42ba508ac7f r26343:f42ba508ac7f r5584:545d748cc681 r5584:545d748cc681 r15610:623a23fb6560 r16081:e554542808c8 r16081:e554542808c8 r5584:545d748cc681 r5584:545d748cc681 r27470:d6d867135eef r5584:545d748cc681 r27470:d6d867135eef r27470:d6d867135eef r27470:d6d867135eef r27470:d6d867135eef r5584:545d748cc681 r27470:d6d867135eef r5584:545d748cc681 r12984:b9c53ed05d55 r12984:b9c53ed05d55 r28620:953e949c2631 r28620:953e949c2631 r28620:953e949c2631 r28505:5212736360c6 r28620:953e949c2631 r28505:5212736360c6 r12984:b9c53ed05d55 r28620:953e949c2631 r12984:b9c53ed05d55 r28505:5212736360c6 r28620:953e949c2631 r28505:5212736360c6 r12984:b9c53ed05d55 r28505:5212736360c6 r12984:b9c53ed05d55 r12984:b9c53ed05d55 r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae | /*
* This file is part of OpenTTD.
* 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.
* 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.
* 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/>.
*/
/** @file debug.cpp Handling of printing debug messages. */
#include "stdafx.h"
#include "console_func.h"
#include "debug.h"
#include "string_func.h"
#include "fileio_func.h"
#include "settings_type.h"
#include <mutex>
#if defined(_WIN32)
#include "os/windows/win32.h"
#endif
#include "3rdparty/fmt/chrono.h"
#include "network/network_admin.h"
#include "safeguards.h"
/** Element in the queue of debug messages that have to be passed to either NetworkAdminConsole or IConsolePrint.*/
struct QueuedDebugItem {
std::string level; ///< The used debug level.
std::string message; ///< The actual formatted message.
};
std::atomic<bool> _debug_remote_console; ///< Whether we need to send data to either NetworkAdminConsole or IConsolePrint.
std::mutex _debug_remote_console_mutex; ///< Mutex to guard the queue of debug messages for either NetworkAdminConsole or IConsolePrint.
std::vector<QueuedDebugItem> _debug_remote_console_queue; ///< Queue for debug messages to be passed to NetworkAdminConsole or IConsolePrint.
std::vector<QueuedDebugItem> _debug_remote_console_queue_spare; ///< Spare queue to swap with _debug_remote_console_queue.
int _debug_driver_level;
int _debug_grf_level;
int _debug_map_level;
int _debug_misc_level;
int _debug_net_level;
int _debug_sprite_level;
int _debug_oldloader_level;
int _debug_npf_level;
int _debug_yapf_level;
int _debug_fontcache_level;
int _debug_script_level;
int _debug_sl_level;
int _debug_gamelog_level;
int _debug_desync_level;
int _debug_console_level;
#ifdef RANDOM_DEBUG
int _debug_random_level;
#endif
struct DebugLevel {
const char *name;
int *level;
};
#define DEBUG_LEVEL(x) { #x, &_debug_##x##_level }
static const DebugLevel debug_level[] = {
DEBUG_LEVEL(driver),
DEBUG_LEVEL(grf),
DEBUG_LEVEL(map),
DEBUG_LEVEL(misc),
DEBUG_LEVEL(net),
DEBUG_LEVEL(sprite),
DEBUG_LEVEL(oldloader),
DEBUG_LEVEL(npf),
DEBUG_LEVEL(yapf),
DEBUG_LEVEL(fontcache),
DEBUG_LEVEL(script),
DEBUG_LEVEL(sl),
DEBUG_LEVEL(gamelog),
DEBUG_LEVEL(desync),
DEBUG_LEVEL(console),
#ifdef RANDOM_DEBUG
DEBUG_LEVEL(random),
#endif
};
#undef DEBUG_LEVEL
/**
* Dump the available debug facility names in the help text.
* @param output_iterator The iterator to write the string to.
*/
void DumpDebugFacilityNames(std::back_insert_iterator<std::string> &output_iterator)
{
bool written = false;
for (const DebugLevel *i = debug_level; i != endof(debug_level); ++i) {
if (!written) {
fmt::format_to(output_iterator, "List of debug facility names:\n");
} else {
fmt::format_to(output_iterator, ", ");
}
fmt::format_to(output_iterator, "{}", i->name);
written = true;
}
if (written) {
fmt::format_to(output_iterator, "\n\n");
}
}
/**
* Internal function for outputting the debug line.
* @param level Debug category.
* @param message The message to output.
*/
void DebugPrint(const char *category, int level, const std::string &message)
{
if (strcmp(category, "desync") == 0) {
static FILE *f = FioFOpenFile("commands-out.log", "wb", AUTOSAVE_DIR);
if (f == nullptr) return;
fmt::print(f, "{}{}\n", GetLogPrefix(true), message);
fflush(f);
#ifdef RANDOM_DEBUG
} else if (strcmp(category, "random") == 0) {
static FILE *f = FioFOpenFile("random-out.log", "wb", AUTOSAVE_DIR);
if (f == nullptr) return;
fmt::print(f, "{}\n", message);
fflush(f);
#endif
} else {
fmt::print(stderr, "{}dbg: [{}:{}] {}\n", GetLogPrefix(true), category, level, message);
if (_debug_remote_console.load()) {
/* Only add to the queue when there is at least one consumer of the data. */
std::lock_guard<std::mutex> lock(_debug_remote_console_mutex);
_debug_remote_console_queue.push_back({ category, message });
}
}
}
/**
* Set debugging levels by parsing the text in \a s.
* For setting individual levels a string like \c "net=3,grf=6" should be used.
* If the string starts with a number, the number is used as global debugging level.
* @param s Text describing the wanted debugging levels.
* @param error_func The function to call if a parse error occurs.
*/
void SetDebugString(const char *s, void (*error_func)(const std::string &))
{
int v;
char *end;
const char *t;
/* Store planned changes into map during parse */
std::map<const char *, int> new_levels;
/* Global debugging level? */
if (*s >= '0' && *s <= '9') {
const DebugLevel *i;
v = std::strtoul(s, &end, 0);
s = end;
for (i = debug_level; i != endof(debug_level); ++i) {
new_levels[i->name] = v;
}
}
/* Individual levels */
for (;;) {
/* skip delimiters */
while (*s == ' ' || *s == ',' || *s == '\t') s++;
if (*s == '\0') break;
t = s;
while (*s >= 'a' && *s <= 'z') s++;
/* check debugging levels */
const DebugLevel *found = nullptr;
for (const DebugLevel *i = debug_level; i != endof(debug_level); ++i) {
if (s == t + strlen(i->name) && strncmp(t, i->name, s - t) == 0) {
found = i;
break;
}
}
if (*s == '=') s++;
v = std::strtoul(s, &end, 0);
s = end;
if (found != nullptr) {
new_levels[found->name] = v;
} else {
std::string error_string = fmt::format("Unknown debug level '{}'", std::string(t, s - t));
error_func(error_string);
return;
}
}
/* Apply the changes after parse is successful */
for (const DebugLevel *i = debug_level; i != endof(debug_level); ++i) {
const auto &nl = new_levels.find(i->name);
if (nl != new_levels.end()) {
*i->level = nl->second;
}
}
}
/**
* Print out the current debug-level.
* Just return a string with the values of all the debug categories.
* @return string with debug-levels
*/
std::string GetDebugString()
{
std::string result;
for (const DebugLevel *i = debug_level; i != endof(debug_level); ++i) {
if (!result.empty()) result += ", ";
fmt::format_to(std::back_inserter(result), "{}={}", i->name, *i->level);
}
return result;
}
/**
* Get the prefix for logs.
*
* If show_date_in_logs or \p force is enabled it returns
* the date, otherwise it returns an empty string.
*
* @return the prefix for logs.
*/
std::string GetLogPrefix(bool force)
{
std::string log_prefix;
if (force || _settings_client.gui.show_date_in_logs) {
log_prefix = fmt::format("[{:%Y-%m-%d %H:%M:%S}] ", fmt::localtime(time(nullptr)));
}
return log_prefix;
}
/**
* Send the queued Debug messages to either NetworkAdminConsole or IConsolePrint from the
* GameLoop thread to prevent concurrent accesses to both the NetworkAdmin's packet queue
* as well as IConsolePrint's buffers.
*
* This is to be called from the GameLoop thread.
*/
void DebugSendRemoteMessages()
{
if (!_debug_remote_console.load()) return;
{
std::lock_guard<std::mutex> lock(_debug_remote_console_mutex);
std::swap(_debug_remote_console_queue, _debug_remote_console_queue_spare);
}
for (auto &item : _debug_remote_console_queue_spare) {
NetworkAdminConsole(item.level, item.message);
if (_settings_client.gui.developer >= 2) IConsolePrint(CC_DEBUG, "dbg: [{}] {}", item.level, item.message);
}
_debug_remote_console_queue_spare.clear();
}
/**
* Reconsider whether we need to send debug messages to either NetworkAdminConsole
* or IConsolePrint. The former is when they have enabled console handling whereas
* the latter depends on the gui.developer setting's value.
*
* This is to be called from the GameLoop thread.
*/
void DebugReconsiderSendRemoteMessages()
{
bool enable = _settings_client.gui.developer >= 2;
for (ServerNetworkAdminSocketHandler *as : ServerNetworkAdminSocketHandler::IterateActive()) {
if (as->update_frequency[ADMIN_UPDATE_CONSOLE] & ADMIN_FREQUENCY_AUTOMATIC) {
enable = true;
break;
}
}
_debug_remote_console.store(enable);
}
|