author | Tero Marttila <terom@fixme.fi> |
Fri, 18 Jul 2008 21:28:42 +0300 | |
changeset 11175 | 020c61e39c94 |
parent 11170 | 3646f7f4fcfc |
child 11178 | aa617a8b4f34 |
permissions | -rw-r--r-- |
2186 | 1 |
/* $Id$ */ |
2 |
||
10429
1b99254f9607
(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:
10154
diff
changeset
|
3 |
/** @file debug.h Functions related to debugging. */ |
6505
abcb0580d976
(svn r8950) -Cleanup: doxygen changes. Mostly @files missing tags and a few comments style.
belugas
parents:
6192
diff
changeset
|
4 |
|
1299 | 5 |
#ifndef DEBUG_H |
6 |
#define DEBUG_H |
|
7 |
||
5568
75f13d7bfaed
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
8 |
/* Debugging messages policy: |
75f13d7bfaed
(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 |
75f13d7bfaed
(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 |
75f13d7bfaed
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
11 |
* debugging is needed. |
75f13d7bfaed
(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): |
75f13d7bfaed
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
13 |
* 0 - errors or severe warnings |
75f13d7bfaed
(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 |
75f13d7bfaed
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
15 |
* 2 - crude progress indicator of functionality |
75f13d7bfaed
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
16 |
* 3 - important debugging messages (function entry) |
75f13d7bfaed
(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.) |
75f13d7bfaed
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
18 |
* 5 - detailed debugging information |
75f13d7bfaed
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
19 |
* 6.. - extremely detailed spamming |
75f13d7bfaed
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
20 |
*/ |
75f13d7bfaed
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
21 |
|
1299 | 22 |
#ifdef NO_DEBUG_MESSAGES |
8905
a6974b6041d9
(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:
8743
diff
changeset
|
23 |
#if defined(__GNUC__) && (__GNUC__ < 3) |
11170
3646f7f4fcfc
(svn r13728) -Codechange: define DEBUG as an empty block so compiler warns us less
smatz
parents:
11169
diff
changeset
|
24 |
#define DEBUG(name, level, args...) { } |
5657
54c99d0f6ba4
(svn r7602) -Fix (r7565): MSVC2003 and lower don't support variadic macros, so work around
Darkvater
parents:
5578
diff
changeset
|
25 |
#else |
11170
3646f7f4fcfc
(svn r13728) -Codechange: define DEBUG as an empty block so compiler warns us less
smatz
parents:
11169
diff
changeset
|
26 |
#define DEBUG(name, level, ...) { } |
5657
54c99d0f6ba4
(svn r7602) -Fix (r7565): MSVC2003 and lower don't support variadic macros, so work around
Darkvater
parents:
5578
diff
changeset
|
27 |
#endif |
54c99d0f6ba4
(svn r7602) -Fix (r7565): MSVC2003 and lower don't support variadic macros, so work around
Darkvater
parents:
5578
diff
changeset
|
28 |
#else /* NO_DEBUG_MESSAGES */ |
8905
a6974b6041d9
(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:
8743
diff
changeset
|
29 |
#if defined(__GNUC__) && (__GNUC__ < 3) |
5578
595d940beb8f
(svn r7579) -Fix: upon merging the bridge branch, I accidently reverted 7571. Re-revert it. Sorry.
celestar
parents:
5573
diff
changeset
|
30 |
#define DEBUG(name, level, args...) if ((level == 0) || ( _debug_ ## name ## _level >= level)) debug(#name, args) |
595d940beb8f
(svn r7579) -Fix: upon merging the bridge branch, I accidently reverted 7571. Re-revert it. Sorry.
celestar
parents:
5573
diff
changeset
|
31 |
#else |
595d940beb8f
(svn r7579) -Fix: upon merging the bridge branch, I accidently reverted 7571. Re-revert it. Sorry.
celestar
parents:
5573
diff
changeset
|
32 |
#define DEBUG(name, level, ...) if (level == 0 || _debug_ ## name ## _level >= level) debug(#name, __VA_ARGS__) |
595d940beb8f
(svn r7579) -Fix: upon merging the bridge branch, I accidently reverted 7571. Re-revert it. Sorry.
celestar
parents:
5573
diff
changeset
|
33 |
#endif |
1299 | 34 |
|
35 |
extern int _debug_ai_level; |
|
2210
58a293892a66
(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; |
|
5568
75f13d7bfaed
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
42 |
extern int _debug_sprite_level; |
1322
8697b73baa64
(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
3098398bf7ff
(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
838dd6f46081
(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
4984308f9125
(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
dc67d70b5a45
(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; |
5568
75f13d7bfaed
(svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to
Darkvater
parents:
5108
diff
changeset
|
48 |
extern int _debug_sl_level; |
5915 | 49 |
extern int _debug_station_level; |
10824
1a34ba6f338a
(svn r13375) -Add: logging of actions that could possibly cause desyncs and crashes to simplify debugging. See readme.txt for details
smatz
parents:
10429
diff
changeset
|
50 |
extern int _debug_gamelog_level; |
1299 | 51 |
|
8905
a6974b6041d9
(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:
8743
diff
changeset
|
52 |
void CDECL debug(const char *dbg, ...); |
5657
54c99d0f6ba4
(svn r7602) -Fix (r7565): MSVC2003 and lower don't support variadic macros, so work around
Darkvater
parents:
5578
diff
changeset
|
53 |
#endif /* NO_DEBUG_MESSAGES */ |
1299 | 54 |
|
55 |
void SetDebugString(const char *s); |
|
6573 | 56 |
const char *GetDebugString(); |
1299 | 57 |
|
3851
4bbb525957b0
(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* */ |
4bbb525957b0
(svn r4875) - Fix: %ll don't work with mingw (msvrct.dll problem)
glx
parents:
3341
diff
changeset
|
59 |
#if defined(_MSC_VER) || defined(__MINGW32__) |
5657
54c99d0f6ba4
(svn r7602) -Fix (r7565): MSVC2003 and lower don't support variadic macros, so work around
Darkvater
parents:
5578
diff
changeset
|
60 |
#define OTTD_PRINTF64 "I64" |
3341
b8febc9509d7
(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 |
5657
54c99d0f6ba4
(svn r7602) -Fix (r7565): MSVC2003 and lower don't support variadic macros, so work around
Darkvater
parents:
5578
diff
changeset
|
62 |
#define OTTD_PRINTF64 "ll" |
3341
b8febc9509d7
(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 |
b8febc9509d7
(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 |
|
7326
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
65 |
/* Used for profiling |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
66 |
* |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
67 |
* Usage: |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
68 |
* TIC(); |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
69 |
* --Do your code-- |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
70 |
* TOC("A name", 1); |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
71 |
* |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
72 |
* When you run the TIC() / TOC() multiple times, you can increase the '1' |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
73 |
* to only display average stats every N values. Some things to know: |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
74 |
* |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
75 |
* for (int i = 0; i < 5; i++) { |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
76 |
* TIC(); |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
77 |
* --Do yuor code-- |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
78 |
* TOC("A name", 5); |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
79 |
* } |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
80 |
* |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
81 |
* Is the correct usage for multiple TIC() / TOC() calls. |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
82 |
* |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
83 |
* TIC() / TOC() creates it's own block, so make sure not the mangle |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
84 |
* it with an other block. |
290fdfc54179
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
truelight
parents:
6573
diff
changeset
|
85 |
**/ |
3341
b8febc9509d7
(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() {\ |
6573 | 87 |
extern uint64 _rdtsc();\ |
3341
b8febc9509d7
(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
|
88 |
uint64 _xxx_ = _rdtsc();\ |
b8febc9509d7
(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;\ |
b8febc9509d7
(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; |
b8febc9509d7
(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 |
|
b8febc9509d7
(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)\ |
b8febc9509d7
(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
|
93 |
__sum__ += _rdtsc() - _xxx_;\ |
b8febc9509d7
(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) {\ |
5568
75f13d7bfaed
(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
b8febc9509d7
(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;\ |
b8febc9509d7
(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;\ |
b8febc9509d7
(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 |
}\ |
b8febc9509d7
(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 |
} |
b8febc9509d7
(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 |
|
8627
448ebf3a8291
(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:
7326
diff
changeset
|
101 |
void ShowInfo(const char *str); |
448ebf3a8291
(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:
7326
diff
changeset
|
102 |
void CDECL ShowInfoF(const char *str, ...); |
448ebf3a8291
(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:
7326
diff
changeset
|
103 |
|
8743
62a558995c35
(svn r11811) -Fix: make compilation without networking work again (and thus move the debugdumpcommand stuff out of the network 'area').
rubidium
parents:
8627
diff
changeset
|
104 |
#ifdef DEBUG_DUMP_COMMANDS |
62a558995c35
(svn r11811) -Fix: make compilation without networking work again (and thus move the debugdumpcommand stuff out of the network 'area').
rubidium
parents:
8627
diff
changeset
|
105 |
void CDECL DebugDumpCommands(const char *s, ...); |
62a558995c35
(svn r11811) -Fix: make compilation without networking work again (and thus move the debugdumpcommand stuff out of the network 'area').
rubidium
parents:
8627
diff
changeset
|
106 |
#else /* DEBUG_DUMP_COMMANDS */ |
10154
4ab34b8aad67
(svn r12685) -Codechange: DebugDumpCommands() couldn't be inlined, define it as a macro instead
smatz
parents:
8905
diff
changeset
|
107 |
/* when defined as an empty function with variable argument list, |
4ab34b8aad67
(svn r12685) -Codechange: DebugDumpCommands() couldn't be inlined, define it as a macro instead
smatz
parents:
8905
diff
changeset
|
108 |
* it can't be inlined - so define it as an empty macro */ |
4ab34b8aad67
(svn r12685) -Codechange: DebugDumpCommands() couldn't be inlined, define it as a macro instead
smatz
parents:
8905
diff
changeset
|
109 |
#if defined(__GNUC__) && (__GNUC__ < 3) |
4ab34b8aad67
(svn r12685) -Codechange: DebugDumpCommands() couldn't be inlined, define it as a macro instead
smatz
parents:
8905
diff
changeset
|
110 |
#define DebugDumpCommands(s, args...) |
4ab34b8aad67
(svn r12685) -Codechange: DebugDumpCommands() couldn't be inlined, define it as a macro instead
smatz
parents:
8905
diff
changeset
|
111 |
#else |
4ab34b8aad67
(svn r12685) -Codechange: DebugDumpCommands() couldn't be inlined, define it as a macro instead
smatz
parents:
8905
diff
changeset
|
112 |
#define DebugDumpCommands(s, ...) |
4ab34b8aad67
(svn r12685) -Codechange: DebugDumpCommands() couldn't be inlined, define it as a macro instead
smatz
parents:
8905
diff
changeset
|
113 |
#endif |
8743
62a558995c35
(svn r11811) -Fix: make compilation without networking work again (and thus move the debugdumpcommand stuff out of the network 'area').
rubidium
parents:
8627
diff
changeset
|
114 |
#endif /* DEBUG_DUMP_COMMANDS */ |
62a558995c35
(svn r11811) -Fix: make compilation without networking work again (and thus move the debugdumpcommand stuff out of the network 'area').
rubidium
parents:
8627
diff
changeset
|
115 |
|
2436
177cb6a8339f
(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 */ |