author | translators |
Mon, 15 Dec 2008 11:39:23 +0000 | |
changeset 10424 | 99036ab7085e |
parent 10383 | 7aee0e95303f |
permissions | -rw-r--r-- |
2186 | 1 |
/* $Id$ */ |
2 |
||
9111
48ce04029fe4
(svn r12971) -Documentation: add @file in files that missed them and add something more than whitespace as description of files that don't have a description.
rubidium
parents:
8915
diff
changeset
|
3 |
/** @file debug.h Functions related to debugging. */ |
6179
d19b0137d8e4
(svn r8950) -Cleanup: doxygen changes. Mostly @files missing tags and a few comments style.
belugas
parents:
5941
diff
changeset
|
4 |
|
1299 | 5 |
#ifndef DEBUG_H |
6 |
#define DEBUG_H |
|
7 |
||
5380
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
8 |
/* Debugging messages policy: |
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
9 |
* These should be the severities used for direct DEBUG() calls |
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
10 |
* maximum debugging level should be 10 if really deep, deep |
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
11 |
* debugging is needed. |
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
12 |
* (there is room for exceptions, but you have to have a good cause): |
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
13 |
* 0 - errors or severe warnings |
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
14 |
* 1 - other non-fatal, non-severe warnings |
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
15 |
* 2 - crude progress indicator of functionality |
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
16 |
* 3 - important debugging messages (function entry) |
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
17 |
* 4 - debugging messages (crude loop status, etc.) |
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
18 |
* 5 - detailed debugging information |
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
19 |
* 6.. - extremely detailed spamming |
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
20 |
*/ |
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
21 |
|
1299 | 22 |
#ifdef NO_DEBUG_MESSAGES |
8409
de295d5e2bb4
(svn r11979) -Codechange: drop MSVC 2003 support because MSVC 2003 is broken in such a manner that it triggers an internal compiler error without any clue what of the code is wrong. Even trying to bisect the problem does not give a single line of code that causes the trouble.
rubidium
parents:
8247
diff
changeset
|
23 |
#if defined(__GNUC__) && (__GNUC__ < 3) |
9656
5a22c8e52f84
(svn r13728) -Codechange: define DEBUG as an empty block so compiler warns us less
smatz
parents:
9655
diff
changeset
|
24 |
#define DEBUG(name, level, args...) { } |
5406
2df85542fee4
(svn r7602) -Fix (r7565): MSVC2003 and lower don't support variadic macros, so work around
Darkvater
parents:
5390
diff
changeset
|
25 |
#else |
9656
5a22c8e52f84
(svn r13728) -Codechange: define DEBUG as an empty block so compiler warns us less
smatz
parents:
9655
diff
changeset
|
26 |
#define DEBUG(name, level, ...) { } |
5406
2df85542fee4
(svn r7602) -Fix (r7565): MSVC2003 and lower don't support variadic macros, so work around
Darkvater
parents:
5390
diff
changeset
|
27 |
#endif |
2df85542fee4
(svn r7602) -Fix (r7565): MSVC2003 and lower don't support variadic macros, so work around
Darkvater
parents:
5390
diff
changeset
|
28 |
#else /* NO_DEBUG_MESSAGES */ |
8409
de295d5e2bb4
(svn r11979) -Codechange: drop MSVC 2003 support because MSVC 2003 is broken in such a manner that it triggers an internal compiler error without any clue what of the code is wrong. Even trying to bisect the problem does not give a single line of code that causes the trouble.
rubidium
parents:
8247
diff
changeset
|
29 |
#if defined(__GNUC__) && (__GNUC__ < 3) |
5390
b51df40d72a1
(svn r7579) -Fix: upon merging the bridge branch, I accidently reverted 7571. Re-revert it. Sorry.
celestar
parents:
5385
diff
changeset
|
30 |
#define DEBUG(name, level, args...) if ((level == 0) || ( _debug_ ## name ## _level >= level)) debug(#name, args) |
b51df40d72a1
(svn r7579) -Fix: upon merging the bridge branch, I accidently reverted 7571. Re-revert it. Sorry.
celestar
parents:
5385
diff
changeset
|
31 |
#else |
b51df40d72a1
(svn r7579) -Fix: upon merging the bridge branch, I accidently reverted 7571. Re-revert it. Sorry.
celestar
parents:
5385
diff
changeset
|
32 |
#define DEBUG(name, level, ...) if (level == 0 || _debug_ ## name ## _level >= level) debug(#name, __VA_ARGS__) |
b51df40d72a1
(svn r7579) -Fix: upon merging the bridge branch, I accidently reverted 7571. Re-revert it. Sorry.
celestar
parents:
5385
diff
changeset
|
33 |
#endif |
1299 | 34 |
|
35 |
extern int _debug_ai_level; |
|
2210
b76184e0929c
(svn r2728) -Fix/Feature: Change the driver probing algorithm
tron
parents:
2186
diff
changeset
|
36 |
extern int _debug_driver_level; |
1299 | 37 |
extern int _debug_grf_level; |
38 |
extern int _debug_map_level; |
|
39 |
extern int _debug_misc_level; |
|
40 |
extern int _debug_ms_level; |
|
41 |
extern int _debug_net_level; |
|
5380
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
42 |
extern int _debug_sprite_level; |
1322
a7fef520f54c
(svn r1826) -Feature: a brand new OldLoader so OpenTTD is TTD(Patch) compatible
truelight
parents:
1299
diff
changeset
|
43 |
extern int _debug_oldloader_level; |
2125
edc17858f9f6
(svn r2635) Fix: [ntp/misc] Improve the old pathfinder. Changed it to A* instead of Dijkstra.
ludde
parents:
2033
diff
changeset
|
44 |
extern int _debug_ntp_level; |
1678
187385f01cc9
(svn r2182) - Add: [NPF] There is now a debug class for NPF. Use -d npf<level> to enable debugging printouts from npf.
matthijs
parents:
1322
diff
changeset
|
45 |
extern int _debug_npf_level; |
3900
2c84ed52709d
(svn r4987) Feature: Merged YAPF into trunk. Thanks to devs for continuous support and users for testing.
KUDr
parents:
3851
diff
changeset
|
46 |
extern int _debug_yapf_level; |
5108
aeaef6fe53b7
(svn r7182) -Feature: Merge utf8 branch. This brings us support for Unicode/UTF-8 and the option for fonts rendered by FreeType. Language changes to come.
peter1138
parents:
3900
diff
changeset
|
47 |
extern int _debug_freetype_level; |
5380
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
48 |
extern int _debug_sl_level; |
5664 | 49 |
extern int _debug_station_level; |
9457
75f11a6caef8
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
9111
diff
changeset
|
50 |
extern int _debug_gamelog_level; |
1299 | 51 |
|
8409
de295d5e2bb4
(svn r11979) -Codechange: drop MSVC 2003 support because MSVC 2003 is broken in such a manner that it triggers an internal compiler error without any clue what of the code is wrong. Even trying to bisect the problem does not give a single line of code that causes the trouble.
rubidium
parents:
8247
diff
changeset
|
52 |
void CDECL debug(const char *dbg, ...); |
5406
2df85542fee4
(svn r7602) -Fix (r7565): MSVC2003 and lower don't support variadic macros, so work around
Darkvater
parents:
5390
diff
changeset
|
53 |
#endif /* NO_DEBUG_MESSAGES */ |
1299 | 54 |
|
55 |
void SetDebugString(const char *s); |
|
6247 | 56 |
const char *GetDebugString(); |
1299 | 57 |
|
3851
9ad2f4ec0ac3
(svn r4875) - Fix: %ll don't work with mingw (msvrct.dll problem)
glx
parents:
3341
diff
changeset
|
58 |
/* MSVCRT of course has to have a different syntax for long long *sigh* */ |
9ad2f4ec0ac3
(svn r4875) - Fix: %ll don't work with mingw (msvrct.dll problem)
glx
parents:
3341
diff
changeset
|
59 |
#if defined(_MSC_VER) || defined(__MINGW32__) |
5406
2df85542fee4
(svn r7602) -Fix (r7565): MSVC2003 and lower don't support variadic macros, so work around
Darkvater
parents:
5390
diff
changeset
|
60 |
#define OTTD_PRINTF64 "I64" |
3341
b20541ef8945
(svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later.
Darkvater
parents:
2916
diff
changeset
|
61 |
#else |
5406
2df85542fee4
(svn r7602) -Fix (r7565): MSVC2003 and lower don't support variadic macros, so work around
Darkvater
parents:
5390
diff
changeset
|
62 |
#define OTTD_PRINTF64 "ll" |
3341
b20541ef8945
(svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later.
Darkvater
parents:
2916
diff
changeset
|
63 |
#endif |
b20541ef8945
(svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later.
Darkvater
parents:
2916
diff
changeset
|
64 |
|
6830
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
65 |
/* Used for profiling |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
66 |
* |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
67 |
* Usage: |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
68 |
* TIC(); |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
69 |
* --Do your code-- |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
70 |
* TOC("A name", 1); |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
71 |
* |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
72 |
* When you run the TIC() / TOC() multiple times, you can increase the '1' |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
73 |
* to only display average stats every N values. Some things to know: |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
74 |
* |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
75 |
* for (int i = 0; i < 5; i++) { |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
76 |
* TIC(); |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
77 |
* --Do yuor code-- |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
78 |
* TOC("A name", 5); |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
79 |
* } |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
80 |
* |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
81 |
* Is the correct usage for multiple TIC() / TOC() calls. |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
82 |
* |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
83 |
* TIC() / TOC() creates it's own block, so make sure not the mangle |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
84 |
* it with an other block. |
37507080af66
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6247
diff
changeset
|
85 |
**/ |
3341
b20541ef8945
(svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later.
Darkvater
parents:
2916
diff
changeset
|
86 |
#define TIC() {\ |
10383
7aee0e95303f
(svn r14634) -Change: _rdtsc is defined by some platforms so we can't use that name.
rubidium
parents:
9656
diff
changeset
|
87 |
extern uint64 ottd_rdtsc();\ |
7aee0e95303f
(svn r14634) -Change: _rdtsc is defined by some platforms so we can't use that name.
rubidium
parents:
9656
diff
changeset
|
88 |
uint64 _xxx_ = ottd_rdtsc();\ |
3341
b20541ef8945
(svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later.
Darkvater
parents:
2916
diff
changeset
|
89 |
static uint64 __sum__ = 0;\ |
b20541ef8945
(svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later.
Darkvater
parents:
2916
diff
changeset
|
90 |
static uint32 __i__ = 0; |
b20541ef8945
(svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later.
Darkvater
parents:
2916
diff
changeset
|
91 |
|
b20541ef8945
(svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later.
Darkvater
parents:
2916
diff
changeset
|
92 |
#define TOC(str, count)\ |
10383
7aee0e95303f
(svn r14634) -Change: _rdtsc is defined by some platforms so we can't use that name.
rubidium
parents:
9656
diff
changeset
|
93 |
__sum__ += ottd_rdtsc() - _xxx_;\ |
3341
b20541ef8945
(svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later.
Darkvater
parents:
2916
diff
changeset
|
94 |
if (++__i__ == count) {\ |
5380
8ea58542b6e0
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
95 |
DEBUG(misc, 0, "[%s] %" OTTD_PRINTF64 "u [avg: %.1f]\n", str, __sum__, __sum__/(double)__i__);\ |
3341
b20541ef8945
(svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later.
Darkvater
parents:
2916
diff
changeset
|
96 |
__i__ = 0;\ |
b20541ef8945
(svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later.
Darkvater
parents:
2916
diff
changeset
|
97 |
__sum__ = 0;\ |
b20541ef8945
(svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later.
Darkvater
parents:
2916
diff
changeset
|
98 |
}\ |
b20541ef8945
(svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later.
Darkvater
parents:
2916
diff
changeset
|
99 |
} |
b20541ef8945
(svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later.
Darkvater
parents:
2916
diff
changeset
|
100 |
|
8131
160939e24ed3
(svn r11692) -Codechange: move some functions from 'functions.h' to a more logical place and remove about 50% of the includes of 'functions.h'
rubidium
parents:
6830
diff
changeset
|
101 |
void ShowInfo(const char *str); |
160939e24ed3
(svn r11692) -Codechange: move some functions from 'functions.h' to a more logical place and remove about 50% of the includes of 'functions.h'
rubidium
parents:
6830
diff
changeset
|
102 |
void CDECL ShowInfoF(const char *str, ...); |
160939e24ed3
(svn r11692) -Codechange: move some functions from 'functions.h' to a more logical place and remove about 50% of the includes of 'functions.h'
rubidium
parents:
6830
diff
changeset
|
103 |
|
8247
16e1c8db6f55
(svn r11811) -Fix: make compilation without networking work again (and thus move the debugdumpcommand stuff out of the network 'area').
rubidium
parents:
8131
diff
changeset
|
104 |
#ifdef DEBUG_DUMP_COMMANDS |
16e1c8db6f55
(svn r11811) -Fix: make compilation without networking work again (and thus move the debugdumpcommand stuff out of the network 'area').
rubidium
parents:
8131
diff
changeset
|
105 |
void CDECL DebugDumpCommands(const char *s, ...); |
16e1c8db6f55
(svn r11811) -Fix: make compilation without networking work again (and thus move the debugdumpcommand stuff out of the network 'area').
rubidium
parents:
8131
diff
changeset
|
106 |
#else /* DEBUG_DUMP_COMMANDS */ |
8915
ea2b40b02844
(svn r12685) -Codechange: DebugDumpCommands() couldn't be inlined, define it as a macro instead
smatz
parents:
8409
diff
changeset
|
107 |
/* when defined as an empty function with variable argument list, |
ea2b40b02844
(svn r12685) -Codechange: DebugDumpCommands() couldn't be inlined, define it as a macro instead
smatz
parents:
8409
diff
changeset
|
108 |
* it can't be inlined - so define it as an empty macro */ |
ea2b40b02844
(svn r12685) -Codechange: DebugDumpCommands() couldn't be inlined, define it as a macro instead
smatz
parents:
8409
diff
changeset
|
109 |
#if defined(__GNUC__) && (__GNUC__ < 3) |
ea2b40b02844
(svn r12685) -Codechange: DebugDumpCommands() couldn't be inlined, define it as a macro instead
smatz
parents:
8409
diff
changeset
|
110 |
#define DebugDumpCommands(s, args...) |
ea2b40b02844
(svn r12685) -Codechange: DebugDumpCommands() couldn't be inlined, define it as a macro instead
smatz
parents:
8409
diff
changeset
|
111 |
#else |
ea2b40b02844
(svn r12685) -Codechange: DebugDumpCommands() couldn't be inlined, define it as a macro instead
smatz
parents:
8409
diff
changeset
|
112 |
#define DebugDumpCommands(s, ...) |
ea2b40b02844
(svn r12685) -Codechange: DebugDumpCommands() couldn't be inlined, define it as a macro instead
smatz
parents:
8409
diff
changeset
|
113 |
#endif |
8247
16e1c8db6f55
(svn r11811) -Fix: make compilation without networking work again (and thus move the debugdumpcommand stuff out of the network 'area').
rubidium
parents:
8131
diff
changeset
|
114 |
#endif /* DEBUG_DUMP_COMMANDS */ |
16e1c8db6f55
(svn r11811) -Fix: make compilation without networking work again (and thus move the debugdumpcommand stuff out of the network 'area').
rubidium
parents:
8131
diff
changeset
|
115 |
|
2436
7d5df545bd5d
(svn r2962) - const correctness for all Get* functions and most Draw* functions that don't change their pointer parameters
Darkvater
parents:
2210
diff
changeset
|
116 |
#endif /* DEBUG_H */ |