Files
@ r25958:603d75b53498
Branch filter:
Location: cpp/openttd-patchpack/source/src/debug.h - annotation
r25958:603d75b53498
4.1 KiB
text/x-c
Doc: update multiplayer documentation with latest changes (#9552)
Although several places were fixed during the PR making the change,
not all made it in this document.
While at it, removed all kinds of Markdown warnings by an excessive
usage of spacebar in this document.
Although several places were fixed during the PR making the change,
not all made it in this document.
While at it, removed all kinds of Markdown warnings by an excessive
usage of spacebar in this document.
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 | r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r9111:983de9c5a848 r6179:c0508e7aefec r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r21110:6caf8b808fd2 r23425:b9c622f1f1a7 r25654:e264fd698eb2 r21110:6caf8b808fd2 r5475:3f5cd13d1b63 r25656:3bd4befea0c4 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r25654:e264fd698eb2 r25654:e264fd698eb2 r25654:e264fd698eb2 r25654:e264fd698eb2 r25654:e264fd698eb2 r25654:e264fd698eb2 r25657:33b86bb7de01 r25657:33b86bb7de01 r25654:e264fd698eb2 r22787:1641b12be145 r22787:1641b12be145 r22787:1641b12be145 r22787:1641b12be145 r22787:1641b12be145 r22787:1641b12be145 r22787:1641b12be145 r22787:1641b12be145 r22787:1641b12be145 r22787:1641b12be145 r22787:1641b12be145 r22787:1641b12be145 r22787:1641b12be145 r22787:1641b12be145 r22787:1641b12be145 r18988:3f7b98056f8d r22787:1641b12be145 r18988:3f7b98056f8d r5475:3f5cd13d1b63 r19200:843e97bfe892 r5475:3f5cd13d1b63 r6247:96e840dbefcc r5475:3f5cd13d1b63 r15282:8e9c51163c93 r15282:8e9c51163c93 r15282:8e9c51163c93 r6830:183d677b6bd5 r6830:183d677b6bd5 r6830:183d677b6bd5 r6830:183d677b6bd5 r6830:183d677b6bd5 r6830:183d677b6bd5 r6830:183d677b6bd5 r6830:183d677b6bd5 r6830:183d677b6bd5 r6830:183d677b6bd5 r6830:183d677b6bd5 r6830:183d677b6bd5 r19944:25a78576fb5e r6830:183d677b6bd5 r6830:183d677b6bd5 r6830:183d677b6bd5 r6830:183d677b6bd5 r6830:183d677b6bd5 r14992:2648a73e4ab8 r14126:f23988064e74 r23425:b9c622f1f1a7 r23838:bfeaabaa7b1d r23425:b9c622f1f1a7 r6830:183d677b6bd5 r5475:3f5cd13d1b63 r10383:81614a16573d r23424:8b4ba4ac3de4 r23424:8b4ba4ac3de4 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r23424:8b4ba4ac3de4 r23424:8b4ba4ac3de4 r25655:1030dcb7eb52 r23424:8b4ba4ac3de4 r23424:8b4ba4ac3de4 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r23425:b9c622f1f1a7 r23425:b9c622f1f1a7 r23425:b9c622f1f1a7 r23425:b9c622f1f1a7 r23425:b9c622f1f1a7 r23425:b9c622f1f1a7 r23425:b9c622f1f1a7 r23425:b9c622f1f1a7 r23425:b9c622f1f1a7 r25655:1030dcb7eb52 r23425:b9c622f1f1a7 r23425:b9c622f1f1a7 r23425:b9c622f1f1a7 r23425:b9c622f1f1a7 r23425:b9c622f1f1a7 r23425:b9c622f1f1a7 r8131:7a50db7be0ff r11870:92eb16f6d311 r8131:7a50db7be0ff r12984:b9c53ed05d55 r12984:b9c53ed05d55 r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r25942:fb8ed4e7ecae r5475:3f5cd13d1b63 | /*
* 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.h Functions related to debugging. */
#ifndef DEBUG_H
#define DEBUG_H
#include "cpu.h"
#include <chrono>
#include "3rdparty/fmt/format.h"
/* Debugging messages policy:
* These should be the severities used for direct Debug() calls
* maximum debugging level should be 10 if really deep, deep
* debugging is needed.
* (there is room for exceptions, but you have to have a good cause):
* 0 - errors or severe warnings
* 1 - other non-fatal, non-severe warnings
* 2 - crude progress indicator of functionality
* 3 - important debugging messages (function entry)
* 4 - debugging messages (crude loop status, etc.)
* 5 - detailed debugging information
* 6.. - extremely detailed spamming
*/
/**
* Ouptut a line of debugging information.
* @param name The category of debug information.
* @param level The maximum debug level this message should be shown at. When the debug level for this category is set lower, then the message will not be shown.
* @param format_string The formatting string of the message.
*/
#define Debug(name, level, format_string, ...) if ((level) == 0 || _debug_ ## name ## _level >= (level)) DebugPrint(#name, fmt::format(FMT_STRING(format_string), ## __VA_ARGS__))
void DebugPrint(const char *level, const std::string &message);
extern int _debug_driver_level;
extern int _debug_grf_level;
extern int _debug_map_level;
extern int _debug_misc_level;
extern int _debug_net_level;
extern int _debug_sprite_level;
extern int _debug_oldloader_level;
extern int _debug_npf_level;
extern int _debug_yapf_level;
extern int _debug_freetype_level;
extern int _debug_script_level;
extern int _debug_sl_level;
extern int _debug_gamelog_level;
extern int _debug_desync_level;
extern int _debug_console_level;
#ifdef RANDOM_DEBUG
extern int _debug_random_level;
#endif
char *DumpDebugFacilityNames(char *buf, char *last);
void SetDebugString(const char *s);
const char *GetDebugString();
/* Shorter form for passing filename and linenumber */
#define FILE_LINE __FILE__, __LINE__
/* Used for profiling
*
* Usage:
* TIC();
* --Do your code--
* TOC("A name", 1);
*
* When you run the TIC() / TOC() multiple times, you can increase the '1'
* to only display average stats every N values. Some things to know:
*
* for (int i = 0; i < 5; i++) {
* TIC();
* --Do your code--
* TOC("A name", 5);
* }
*
* Is the correct usage for multiple TIC() / TOC() calls.
*
* TIC() / TOC() creates its own block, so make sure not the mangle
* it with another block.
*
* The output is counted in CPU cycles, and not comparable across
* machines. Mainly useful for local optimisations.
**/
#define TIC() {\
uint64 _xxx_ = ottd_rdtsc();\
static uint64 _sum_ = 0;\
static uint32 _i_ = 0;
#define TOC(str, count)\
_sum_ += ottd_rdtsc() - _xxx_;\
if (++_i_ == count) {\
Debug(misc, 0, "[{}] {} [avg: {:.1f}]", str, _sum_, _sum_/(double)_i_);\
_i_ = 0;\
_sum_ = 0;\
}\
}
/* Chrono based version. The output is in microseconds. */
#define TICC() {\
auto _start_ = std::chrono::high_resolution_clock::now();\
static uint64 _sum_ = 0;\
static uint32 _i_ = 0;
#define TOCC(str, _count_)\
_sum_ += (std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::high_resolution_clock::now() - _start_)).count();\
if (++_i_ == _count_) {\
Debug(misc, 0, "[{}] {} us [avg: {:.1f} us]", str, _sum_, _sum_/(double)_i_);\
_i_ = 0;\
_sum_ = 0;\
}\
}
void ShowInfo(const char *str);
void CDECL ShowInfoF(const char *str, ...) WARN_FORMAT(1, 2);
const char *GetLogPrefix();
void DebugSendRemoteMessages();
void DebugReconsiderSendRemoteMessages();
#endif /* DEBUG_H */
|