-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathwxdebug.cpp
1474 lines (1188 loc) · 46.8 KB
/
wxdebug.cpp
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//------------------------------------------------------------------------------
// File: WXDebug.cpp
//
// Desc: DirectShow base classes - implements ActiveX system debugging
// facilities.
//
// Copyright (c) 1992-2001 Microsoft Corporation. All rights reserved.
//------------------------------------------------------------------------------
#define _WINDLL
#include <streams.h>
#include <stdarg.h>
#include <stdio.h>
#include <dvdmedia.h>
#ifdef DEBUG
#ifdef UNICODE
#ifndef _UNICODE
#define _UNICODE
#endif // _UNICODE
#endif // UNICODE
#endif // DEBUG
#include <tchar.h>
#include <strsafe.h>
#ifdef DEBUG
static void DisplayBITMAPINFO(const BITMAPINFOHEADER* pbmi);
static void DisplayRECT(LPCTSTR szLabel, const RECT& rc);
// The Win32 wsprintf() function writes a maximum of 1024 characters to it's output buffer.
// See the documentation for wsprintf()'s lpOut parameter for more information.
const INT iDEBUGINFO = 1024; // Used to format strings
/* For every module and executable we store a debugging level for each of
the five categories (eg LOG_ERROR and LOG_TIMING). This makes it easy
to isolate and debug individual modules without seeing everybody elses
spurious debug output. The keys are stored in the registry under the
HKEY_LOCAL_MACHINE\SOFTWARE\Debug\<Module Name>\<KeyName> key values
NOTE these must be in the same order as their enumeration definition */
const LPCTSTR pKeyNames[] = {
TEXT("TIMING"), // Timing and performance measurements
TEXT("TRACE"), // General step point call tracing
TEXT("MEMORY"), // Memory and object allocation/destruction
TEXT("LOCKING"), // Locking/unlocking of critical sections
TEXT("ERROR"), // Debug error notification
TEXT("CUSTOM1"),
TEXT("CUSTOM2"),
TEXT("CUSTOM3"),
TEXT("CUSTOM4"),
TEXT("CUSTOM5")
};
const TCHAR CAutoTrace::_szEntering[] = TEXT("->: %s");
const TCHAR CAutoTrace::_szLeaving[] = TEXT("<-: %s");
const INT iMAXLEVELS = NUMELMS(pKeyNames); // Maximum debug categories
HINSTANCE m_hInst; // Module instance handle
TCHAR m_ModuleName[iDEBUGINFO]; // Cut down module name
DWORD m_Levels[iMAXLEVELS]; // Debug level per category
CRITICAL_SECTION m_CSDebug; // Controls access to list
DWORD m_dwNextCookie; // Next active object ID
ObjectDesc *pListHead = NULL; // First active object
DWORD m_dwObjectCount; // Active object count
BOOL m_bInit = FALSE; // Have we been initialised
HANDLE m_hOutput = INVALID_HANDLE_VALUE; // Optional output written here
DWORD dwWaitTimeout = INFINITE; // Default timeout value
DWORD dwTimeOffset; // Time of first DbgLog call
bool g_fUseKASSERT = false; // don't create messagebox
bool g_fDbgInDllEntryPoint = false;
bool g_fAutoRefreshLevels = false;
LPCTSTR pBaseKey = TEXT("SOFTWARE\\Microsoft\\DirectShow\\Debug");
LPCTSTR pGlobalKey = TEXT("GLOBAL");
static CHAR *pUnknownName = "UNKNOWN";
LPCTSTR TimeoutName = TEXT("TIMEOUT");
/* This sets the instance handle that the debug library uses to find
the module's file name from the Win32 GetModuleFileName function */
void WINAPI DbgInitialise(HINSTANCE hInst)
{
InitializeCriticalSection(&m_CSDebug);
m_bInit = TRUE;
m_hInst = hInst;
DbgInitModuleName();
if (GetProfileInt(m_ModuleName, TEXT("BreakOnLoad"), 0))
DebugBreak();
DbgInitModuleSettings(false);
DbgInitGlobalSettings(true);
dwTimeOffset = timeGetTime();
}
/* This is called to clear up any resources the debug library uses - at the
moment we delete our critical section and the object list. The values we
retrieve from the registry are all done during initialisation but we don't
go looking for update notifications while we are running, if the values
are changed then the application has to be restarted to pick them up */
void WINAPI DbgTerminate()
{
if (m_hOutput != INVALID_HANDLE_VALUE) {
EXECUTE_ASSERT(CloseHandle(m_hOutput));
m_hOutput = INVALID_HANDLE_VALUE;
}
DeleteCriticalSection(&m_CSDebug);
m_bInit = FALSE;
}
/* This is called by DbgInitLogLevels to read the debug settings
for each logging category for this module from the registry */
void WINAPI DbgInitKeyLevels(HKEY hKey, bool fTakeMax)
{
LONG lReturn; // Create key return value
LONG lKeyPos; // Current key category
DWORD dwKeySize; // Size of the key value
DWORD dwKeyType; // Receives it's type
DWORD dwKeyValue; // This fields value
/* Try and read a value for each key position in turn */
for (lKeyPos = 0;lKeyPos < iMAXLEVELS;lKeyPos++) {
dwKeySize = sizeof(DWORD);
lReturn = RegQueryValueEx(
hKey, // Handle to an open key
pKeyNames[lKeyPos], // Subkey name derivation
NULL, // Reserved field
&dwKeyType, // Returns the field type
(LPBYTE) &dwKeyValue, // Returns the field's value
&dwKeySize ); // Number of bytes transferred
/* If either the key was not available or it was not a DWORD value
then we ensure only the high priority debug logging is output
but we try and update the field to a zero filled DWORD value */
if (lReturn != ERROR_SUCCESS || dwKeyType != REG_DWORD) {
dwKeyValue = 0;
lReturn = RegSetValueEx(
hKey, // Handle of an open key
pKeyNames[lKeyPos], // Address of subkey name
(DWORD) 0, // Reserved field
REG_DWORD, // Type of the key field
(PBYTE) &dwKeyValue, // Value for the field
sizeof(DWORD)); // Size of the field buffer
if (lReturn != ERROR_SUCCESS) {
DbgLog((LOG_ERROR,1,TEXT("Could not create subkey %s"),pKeyNames[lKeyPos]));
dwKeyValue = 0;
}
}
if(fTakeMax)
{
m_Levels[lKeyPos] = max(dwKeyValue,m_Levels[lKeyPos]);
}
else
{
if((m_Levels[lKeyPos] & LOG_FORCIBLY_SET) == 0) {
m_Levels[lKeyPos] = dwKeyValue;
}
}
}
/* Read the timeout value for catching hangs */
dwKeySize = sizeof(DWORD);
lReturn = RegQueryValueEx(
hKey, // Handle to an open key
TimeoutName, // Subkey name derivation
NULL, // Reserved field
&dwKeyType, // Returns the field type
(LPBYTE) &dwWaitTimeout, // Returns the field's value
&dwKeySize ); // Number of bytes transferred
/* If either the key was not available or it was not a DWORD value
then we ensure only the high priority debug logging is output
but we try and update the field to a zero filled DWORD value */
if (lReturn != ERROR_SUCCESS || dwKeyType != REG_DWORD) {
dwWaitTimeout = INFINITE;
lReturn = RegSetValueEx(
hKey, // Handle of an open key
TimeoutName, // Address of subkey name
(DWORD) 0, // Reserved field
REG_DWORD, // Type of the key field
(PBYTE) &dwWaitTimeout, // Value for the field
sizeof(DWORD)); // Size of the field buffer
if (lReturn != ERROR_SUCCESS) {
DbgLog((LOG_ERROR,1,TEXT("Could not create subkey %s"),pKeyNames[lKeyPos]));
dwWaitTimeout = INFINITE;
}
}
}
void WINAPI DbgOutString(LPCTSTR psz)
{
if (m_hOutput != INVALID_HANDLE_VALUE) {
UINT cb = lstrlen(psz);
DWORD dw;
#ifdef UNICODE
CHAR szDest[2048];
WideCharToMultiByte(CP_ACP, 0, psz, -1, szDest, NUMELMS(szDest), 0, 0);
WriteFile (m_hOutput, szDest, cb, &dw, NULL);
#else
WriteFile (m_hOutput, psz, cb, &dw, NULL);
#endif
} else {
OutputDebugString (psz);
}
}
HRESULT DbgUniqueProcessName(LPCTSTR inName, LPTSTR outName)
{
HRESULT hr = S_OK;
const TCHAR *pIn = inName;
int dotPos = -1;
//scan the input and record the last '.' position
while (*pIn && (pIn - inName) < MAX_PATH)
{
if ( TEXT('.') == *pIn )
dotPos = (int)(pIn-inName);
++pIn;
}
if (*pIn) //input should be zero-terminated within MAX_PATH
return E_INVALIDARG;
DWORD dwProcessId = GetCurrentProcessId();
if (dotPos < 0)
{
//no extension in the input, appending process id to the input
hr = StringCchPrintf(outName, MAX_PATH, TEXT("%s_%d"), inName, dwProcessId);
}
else
{
TCHAR pathAndBasename[MAX_PATH] = {0};
//there's an extension - zero-terminate the path and basename first by copying
hr = StringCchCopyN(pathAndBasename, MAX_PATH, inName, (size_t)dotPos);
//re-combine path, basename and extension with processId appended to a basename
if (SUCCEEDED(hr))
hr = StringCchPrintf(outName, MAX_PATH, TEXT("%s_%d%s"), pathAndBasename, dwProcessId, inName + dotPos);
}
return hr;
}
/* Called by DbgInitGlobalSettings to setup alternate logging destinations
*/
void WINAPI DbgInitLogTo (
HKEY hKey)
{
LONG lReturn;
DWORD dwKeyType;
DWORD dwKeySize;
TCHAR szFile[MAX_PATH] = {0};
static const TCHAR cszKey[] = TEXT("LogToFile");
dwKeySize = MAX_PATH;
lReturn = RegQueryValueEx(
hKey, // Handle to an open key
cszKey, // Subkey name derivation
NULL, // Reserved field
&dwKeyType, // Returns the field type
(LPBYTE) szFile, // Returns the field's value
&dwKeySize); // Number of bytes transferred
// create an empty key if it does not already exist
//
if (lReturn != ERROR_SUCCESS || dwKeyType != REG_SZ)
{
dwKeySize = sizeof(TCHAR);
lReturn = RegSetValueEx(
hKey, // Handle of an open key
cszKey, // Address of subkey name
(DWORD) 0, // Reserved field
REG_SZ, // Type of the key field
(PBYTE)szFile, // Value for the field
dwKeySize); // Size of the field buffer
}
// if an output-to was specified. try to open it.
//
if (m_hOutput != INVALID_HANDLE_VALUE) {
EXECUTE_ASSERT(CloseHandle (m_hOutput));
m_hOutput = INVALID_HANDLE_VALUE;
}
if (szFile[0] != 0)
{
if (!lstrcmpi(szFile, TEXT("Console"))) {
m_hOutput = GetStdHandle (STD_OUTPUT_HANDLE);
if (m_hOutput == INVALID_HANDLE_VALUE) {
AllocConsole ();
m_hOutput = GetStdHandle (STD_OUTPUT_HANDLE);
}
SetConsoleTitle (TEXT("ActiveX Debug Output"));
} else if (szFile[0] &&
lstrcmpi(szFile, TEXT("Debug")) &&
lstrcmpi(szFile, TEXT("Debugger")) &&
lstrcmpi(szFile, TEXT("Deb")))
{
m_hOutput = CreateFile(szFile, GENERIC_WRITE,
FILE_SHARE_READ,
NULL, OPEN_ALWAYS,
FILE_ATTRIBUTE_NORMAL,
NULL);
if (INVALID_HANDLE_VALUE == m_hOutput &&
GetLastError() == ERROR_SHARING_VIOLATION)
{
TCHAR uniqueName[MAX_PATH] = {0};
if (SUCCEEDED(DbgUniqueProcessName(szFile, uniqueName)))
{
m_hOutput = CreateFile(uniqueName, GENERIC_WRITE,
FILE_SHARE_READ,
NULL, OPEN_ALWAYS,
FILE_ATTRIBUTE_NORMAL,
NULL);
}
}
if (INVALID_HANDLE_VALUE != m_hOutput)
{
static const TCHAR cszBar[] = TEXT("\r\n\r\n=====DbgInitialize()=====\r\n\r\n");
SetFilePointer (m_hOutput, 0, NULL, FILE_END);
DbgOutString (cszBar);
}
}
}
}
/* This is called by DbgInitLogLevels to read the global debug settings for
each logging category for this module from the registry. Normally each
module has it's own values set for it's different debug categories but
setting the global SOFTWARE\Debug\Global applies them to ALL modules */
void WINAPI DbgInitGlobalSettings(bool fTakeMax)
{
LONG lReturn; // Create key return value
TCHAR szInfo[iDEBUGINFO]; // Constructs key names
HKEY hGlobalKey; // Global override key
/* Construct the global base key name */
(void)StringCchPrintf(szInfo,NUMELMS(szInfo),TEXT("%s\\%s"),pBaseKey,pGlobalKey);
/* Create or open the key for this module */
lReturn = RegCreateKeyEx(HKEY_LOCAL_MACHINE, // Handle of an open key
szInfo, // Address of subkey name
(DWORD) 0, // Reserved value
NULL, // Address of class name
(DWORD) 0, // Special options flags
GENERIC_READ | GENERIC_WRITE, // Desired security access
NULL, // Key security descriptor
&hGlobalKey, // Opened handle buffer
NULL); // What really happened
if (lReturn != ERROR_SUCCESS) {
lReturn = RegCreateKeyEx(HKEY_LOCAL_MACHINE, // Handle of an open key
szInfo, // Address of subkey name
(DWORD) 0, // Reserved value
NULL, // Address of class name
(DWORD) 0, // Special options flags
GENERIC_READ, // Desired security access
NULL, // Key security descriptor
&hGlobalKey, // Opened handle buffer
NULL); // What really happened
if (lReturn != ERROR_SUCCESS) {
DbgLog((LOG_ERROR,1,TEXT("Could not access GLOBAL module key")));
}
return;
}
DbgInitKeyLevels(hGlobalKey, fTakeMax);
RegCloseKey(hGlobalKey);
}
/* This sets the debugging log levels for the different categories. We start
by opening (or creating if not already available) the SOFTWARE\Debug key
that all these settings live under. We then look at the global values
set under SOFTWARE\Debug\Global which apply on top of the individual
module settings. We then load the individual module registry settings */
void WINAPI DbgInitModuleSettings(bool fTakeMax)
{
LONG lReturn; // Create key return value
TCHAR szInfo[iDEBUGINFO]; // Constructs key names
HKEY hModuleKey; // Module key handle
/* Construct the base key name */
(void)StringCchPrintf(szInfo,NUMELMS(szInfo),TEXT("%s\\%s"),pBaseKey,m_ModuleName);
/* Create or open the key for this module */
lReturn = RegCreateKeyEx(HKEY_LOCAL_MACHINE, // Handle of an open key
szInfo, // Address of subkey name
(DWORD) 0, // Reserved value
NULL, // Address of class name
(DWORD) 0, // Special options flags
GENERIC_READ | GENERIC_WRITE, // Desired security access
NULL, // Key security descriptor
&hModuleKey, // Opened handle buffer
NULL); // What really happened
if (lReturn != ERROR_SUCCESS) {
lReturn = RegCreateKeyEx(HKEY_LOCAL_MACHINE, // Handle of an open key
szInfo, // Address of subkey name
(DWORD) 0, // Reserved value
NULL, // Address of class name
(DWORD) 0, // Special options flags
GENERIC_READ, // Desired security access
NULL, // Key security descriptor
&hModuleKey, // Opened handle buffer
NULL); // What really happened
if (lReturn != ERROR_SUCCESS) {
DbgLog((LOG_ERROR,1,TEXT("Could not access module key")));
}
return;
}
DbgInitLogTo(hModuleKey);
DbgInitKeyLevels(hModuleKey, fTakeMax);
RegCloseKey(hModuleKey);
}
/* Initialise the module file name */
void WINAPI DbgInitModuleName()
{
TCHAR FullName[iDEBUGINFO]; // Load the full path and module name
LPTSTR pName; // Searches from the end for a backslash
GetModuleFileName(m_hInst,FullName,iDEBUGINFO);
pName = _tcsrchr(FullName,'\\');
if (pName == NULL) {
pName = FullName;
} else {
pName++;
}
(void)StringCchCopy(m_ModuleName,NUMELMS(m_ModuleName), pName);
}
struct MsgBoxMsg
{
HWND hwnd;
LPCTSTR szTitle;
LPCTSTR szMessage;
DWORD dwFlags;
INT iResult;
};
//
// create a thread to call MessageBox(). calling MessageBox() on
// random threads at bad times can confuse the host (eg IE).
//
DWORD WINAPI MsgBoxThread(
__inout LPVOID lpParameter // thread data
)
{
MsgBoxMsg *pmsg = (MsgBoxMsg *)lpParameter;
pmsg->iResult = MessageBox(
pmsg->hwnd,
pmsg->szTitle,
pmsg->szMessage,
pmsg->dwFlags);
return 0;
}
INT MessageBoxOtherThread(
HWND hwnd,
LPCTSTR szTitle,
LPCTSTR szMessage,
DWORD dwFlags)
{
if(g_fDbgInDllEntryPoint)
{
// can't wait on another thread because we have the loader
// lock held in the dll entry point.
// This can crash sometimes so just skip it
// return MessageBox(hwnd, szTitle, szMessage, dwFlags);
return IDCANCEL;
}
else
{
MsgBoxMsg msg = {hwnd, szTitle, szMessage, dwFlags, 0};
DWORD dwid;
HANDLE hThread = CreateThread(
0, // security
0, // stack size
MsgBoxThread,
(void *)&msg, // arg
0, // flags
&dwid);
if(hThread)
{
WaitForSingleObject(hThread, INFINITE);
CloseHandle(hThread);
return msg.iResult;
}
// break into debugger on failure.
return IDCANCEL;
}
}
/* Displays a message box if the condition evaluated to FALSE */
void WINAPI DbgAssert(LPCTSTR pCondition,LPCTSTR pFileName,INT iLine)
{
if(g_fUseKASSERT)
{
DbgKernelAssert(pCondition, pFileName, iLine);
}
else
{
TCHAR szInfo[iDEBUGINFO];
(void)StringCchPrintf(szInfo, NUMELMS(szInfo),TEXT("%s \nAt line %d of %s\nContinue? (Cancel to debug)"),
pCondition, iLine, pFileName);
INT MsgId = MessageBoxOtherThread(NULL,szInfo,TEXT("ASSERT Failed"),
MB_SYSTEMMODAL |
MB_ICONHAND |
MB_YESNOCANCEL |
MB_SETFOREGROUND);
switch (MsgId)
{
case IDNO: /* Kill the application */
FatalAppExit(FALSE, TEXT("Application terminated"));
break;
case IDCANCEL: /* Break into the debugger */
DebugBreak();
break;
case IDYES: /* Ignore assertion continue execution */
break;
}
}
}
/* Displays a message box at a break point */
void WINAPI DbgBreakPoint(LPCTSTR pCondition,LPCTSTR pFileName,INT iLine)
{
if(g_fUseKASSERT)
{
DbgKernelAssert(pCondition, pFileName, iLine);
}
else
{
TCHAR szInfo[iDEBUGINFO];
(void)StringCchPrintf(szInfo, NUMELMS(szInfo),TEXT("%s \nAt line %d of %s\nContinue? (Cancel to debug)"),
pCondition, iLine, pFileName);
INT MsgId = MessageBoxOtherThread(NULL,szInfo,TEXT("Hard coded break point"),
MB_SYSTEMMODAL |
MB_ICONHAND |
MB_YESNOCANCEL |
MB_SETFOREGROUND);
switch (MsgId)
{
case IDNO: /* Kill the application */
FatalAppExit(FALSE, TEXT("Application terminated"));
break;
case IDCANCEL: /* Break into the debugger */
DebugBreak();
break;
case IDYES: /* Ignore break point continue execution */
break;
}
}
}
void WINAPI DbgBreakPoint(LPCTSTR pFileName,INT iLine,__format_string LPCTSTR szFormatString,...)
{
// A debug break point message can have at most 2000 characters if
// ANSI or UNICODE characters are being used. A debug break point message
// can have between 1000 and 2000 double byte characters in it. If a
// particular message needs more characters, then the value of this constant
// should be increased.
const DWORD MAX_BREAK_POINT_MESSAGE_SIZE = 2000;
TCHAR szBreakPointMessage[MAX_BREAK_POINT_MESSAGE_SIZE];
va_list va;
va_start( va, szFormatString );
HRESULT hr = StringCchVPrintf( szBreakPointMessage, NUMELMS(szBreakPointMessage), szFormatString, va );
va_end(va);
if( FAILED(hr) ) {
DbgBreak( "ERROR in DbgBreakPoint(). The variable length debug message could not be displayed because StringCchVPrintf() failed." );
return;
}
::DbgBreakPoint( szBreakPointMessage, pFileName, iLine );
}
/* When we initialised the library we stored in the m_Levels array the current
debug output level for this module for each of the five categories. When
some debug logging is sent to us it can be sent with a combination of the
categories (if it is applicable to many for example) in which case we map
the type's categories into their current debug levels and see if any of
them can be accepted. The function looks at each bit position in turn from
the input type field and then compares it's debug level with the modules.
A level of 0 means that output is always sent to the debugger. This is
due to producing output if the input level is <= m_Levels.
*/
BOOL WINAPI DbgCheckModuleLevel(DWORD Type,DWORD Level)
{
if(g_fAutoRefreshLevels)
{
// re-read the registry every second. We cannot use RegNotify() to
// notice registry changes because it's not available on win9x.
static DWORD g_dwLastRefresh = 0;
DWORD dwTime = timeGetTime();
if(dwTime - g_dwLastRefresh > 1000) {
g_dwLastRefresh = dwTime;
// there's a race condition: multiple threads could update the
// values. plus read and write not synchronized. no harm
// though.
DbgInitModuleSettings(false);
}
}
DWORD Mask = 0x01;
// If no valid bits are set return FALSE
if ((Type & ((1<<iMAXLEVELS)-1))) {
// speed up unconditional output.
if (0==Level)
return(TRUE);
for (LONG lKeyPos = 0;lKeyPos < iMAXLEVELS;lKeyPos++) {
if (Type & Mask) {
if (Level <= (m_Levels[lKeyPos] & ~LOG_FORCIBLY_SET)) {
return TRUE;
}
}
Mask <<= 1;
}
}
return FALSE;
}
/* Set debug levels to a given value */
void WINAPI DbgSetModuleLevel(DWORD Type, DWORD Level)
{
DWORD Mask = 0x01;
for (LONG lKeyPos = 0;lKeyPos < iMAXLEVELS;lKeyPos++) {
if (Type & Mask) {
m_Levels[lKeyPos] = Level | LOG_FORCIBLY_SET;
}
Mask <<= 1;
}
}
/* whether to check registry values periodically. this isn't turned
automatically because of the potential performance hit. */
void WINAPI DbgSetAutoRefreshLevels(bool fAuto)
{
g_fAutoRefreshLevels = fAuto;
}
#ifdef UNICODE
//
// warning -- this function is implemented twice for ansi applications
// linking to the unicode library
//
void WINAPI DbgLogInfo(DWORD Type,DWORD Level,__format_string LPCSTR pFormat,...)
{
/* Check the current level for this type combination */
BOOL bAccept = DbgCheckModuleLevel(Type,Level);
if (bAccept == FALSE) {
return;
}
TCHAR szInfo[2000];
/* Format the variable length parameter list */
va_list va;
va_start(va, pFormat);
(void)StringCchPrintf(szInfo, NUMELMS(szInfo),
TEXT("%s(tid %x) %8d : "),
m_ModuleName,
GetCurrentThreadId(), timeGetTime() - dwTimeOffset);
CHAR szInfoA[2000];
WideCharToMultiByte(CP_ACP, 0, szInfo, -1, szInfoA, NUMELMS(szInfoA), 0, 0);
(void)StringCchVPrintfA(szInfoA + lstrlenA(szInfoA), NUMELMS(szInfoA) - lstrlenA(szInfoA), pFormat, va);
(void)StringCchCatA(szInfoA, NUMELMS(szInfoA), "\r\n");
WCHAR wszOutString[2000];
MultiByteToWideChar(CP_ACP, 0, szInfoA, -1, wszOutString, NUMELMS(wszOutString));
DbgOutString(wszOutString);
va_end(va);
}
void WINAPI DbgAssert(LPCSTR pCondition,LPCSTR pFileName,INT iLine)
{
if(g_fUseKASSERT)
{
DbgKernelAssert(pCondition, pFileName, iLine);
}
else
{
TCHAR szInfo[iDEBUGINFO];
(void)StringCchPrintf(szInfo, NUMELMS(szInfo), TEXT("%hs \nAt line %d of %hs\nContinue? (Cancel to debug)"),
pCondition, iLine, pFileName);
INT MsgId = MessageBoxOtherThread(NULL,szInfo,TEXT("ASSERT Failed"),
MB_SYSTEMMODAL |
MB_ICONHAND |
MB_YESNOCANCEL |
MB_SETFOREGROUND);
switch (MsgId)
{
case IDNO: /* Kill the application */
FatalAppExit(FALSE, TEXT("Application terminated"));
break;
case IDCANCEL: /* Break into the debugger */
DebugBreak();
break;
case IDYES: /* Ignore assertion continue execution */
break;
}
}
}
/* Displays a message box at a break point */
void WINAPI DbgBreakPoint(LPCSTR pCondition,LPCSTR pFileName,INT iLine)
{
if(g_fUseKASSERT)
{
DbgKernelAssert(pCondition, pFileName, iLine);
}
else
{
TCHAR szInfo[iDEBUGINFO];
(void)StringCchPrintf(szInfo, NUMELMS(szInfo),TEXT("%hs \nAt line %d of %hs\nContinue? (Cancel to debug)"),
pCondition, iLine, pFileName);
INT MsgId = MessageBoxOtherThread(NULL,szInfo,TEXT("Hard coded break point"),
MB_SYSTEMMODAL |
MB_ICONHAND |
MB_YESNOCANCEL |
MB_SETFOREGROUND);
switch (MsgId)
{
case IDNO: /* Kill the application */
FatalAppExit(FALSE, TEXT("Application terminated"));
break;
case IDCANCEL: /* Break into the debugger */
DebugBreak();
break;
case IDYES: /* Ignore break point continue execution */
break;
}
}
}
void WINAPI DbgKernelAssert(LPCSTR pCondition,LPCSTR pFileName,INT iLine)
{
DbgLog((LOG_ERROR,0,TEXT("Assertion FAILED (%hs) at line %d in file %hs"),
pCondition, iLine, pFileName));
DebugBreak();
}
#endif
/* Print a formatted string to the debugger prefixed with this module's name
Because the COMBASE classes are linked statically every module loaded will
have their own copy of this code. It therefore helps if the module name is
included on the output so that the offending code can be easily found */
//
// warning -- this function is implemented twice for ansi applications
// linking to the unicode library
//
void WINAPI DbgLogInfo(DWORD Type,DWORD Level,LPCTSTR pFormat,...)
{
/* Check the current level for this type combination */
BOOL bAccept = DbgCheckModuleLevel(Type,Level);
if (bAccept == FALSE) {
return;
}
TCHAR szInfo[2000];
/* Format the variable length parameter list */
va_list va;
va_start(va, pFormat);
(void)StringCchPrintf(szInfo, NUMELMS(szInfo),
TEXT("%s(tid %x) %8d : "),
m_ModuleName,
GetCurrentThreadId(), timeGetTime() - dwTimeOffset);
(void)StringCchVPrintf(szInfo + lstrlen(szInfo), NUMELMS(szInfo) - lstrlen(szInfo), pFormat, va);
(void)StringCchCat(szInfo, NUMELMS(szInfo), TEXT("\r\n"));
DbgOutString(szInfo);
va_end(va);
}
/* If we are executing as a pure kernel filter we cannot display message
boxes to the user, this provides an alternative which puts the error
condition on the debugger output with a suitable eye catching message */
void WINAPI DbgKernelAssert(LPCTSTR pCondition,LPCTSTR pFileName,INT iLine)
{
DbgLog((LOG_ERROR,0,TEXT("Assertion FAILED (%s) at line %d in file %s"),
pCondition, iLine, pFileName));
DebugBreak();
}
/* Each time we create an object derived from CBaseObject the constructor will
call us to register the creation of the new object. We are passed a string
description which we store away. We return a cookie that the constructor
uses to identify the object when it is destroyed later on. We update the
total number of active objects in the DLL mainly for debugging purposes */
DWORD WINAPI DbgRegisterObjectCreation(LPCSTR szObjectName,
LPCWSTR wszObjectName)
{
/* If this fires you have a mixed DEBUG/RETAIL build */
ASSERT(!!szObjectName ^ !!wszObjectName);
/* Create a place holder for this object description */
ObjectDesc *pObject = new ObjectDesc;
ASSERT(pObject);
/* It is valid to pass a NULL object name */
if (pObject == NULL) {
return FALSE;
}
/* Check we have been initialised - we may not be initialised when we are
being pulled in from an executable which has globally defined objects
as they are created by the C++ run time before WinMain is called */
if (m_bInit == FALSE) {
DbgInitialise(GetModuleHandle(NULL));
}
/* Grab the list critical section */
EnterCriticalSection(&m_CSDebug);
/* If no name then default to UNKNOWN */
if (!szObjectName && !wszObjectName) {
szObjectName = pUnknownName;
}
/* Put the new description at the head of the list */
pObject->m_szName = szObjectName;
pObject->m_wszName = wszObjectName;
pObject->m_dwCookie = ++m_dwNextCookie;
pObject->m_pNext = pListHead;
pListHead = pObject;
m_dwObjectCount++;
DWORD ObjectCookie = pObject->m_dwCookie;
ASSERT(ObjectCookie);
if(wszObjectName) {
DbgLog((LOG_MEMORY,2,TEXT("Object created %d (%ls) %d Active"),
pObject->m_dwCookie, wszObjectName, m_dwObjectCount));
} else {
DbgLog((LOG_MEMORY,2,TEXT("Object created %d (%hs) %d Active"),
pObject->m_dwCookie, szObjectName, m_dwObjectCount));
}
LeaveCriticalSection(&m_CSDebug);
return ObjectCookie;
}
/* This is called by the CBaseObject destructor when an object is about to be
destroyed, we are passed the cookie we returned during construction that
identifies this object. We scan the object list for a matching cookie and
remove the object if successful. We also update the active object count */
BOOL WINAPI DbgRegisterObjectDestruction(DWORD dwCookie)
{
/* Grab the list critical section */
EnterCriticalSection(&m_CSDebug);
ObjectDesc *pObject = pListHead;
ObjectDesc *pPrevious = NULL;
/* Scan the object list looking for a cookie match */
while (pObject) {
if (pObject->m_dwCookie == dwCookie) {
break;
}
pPrevious = pObject;
pObject = pObject->m_pNext;
}
if (pObject == NULL) {
DbgBreak("Apparently destroying a bogus object");
LeaveCriticalSection(&m_CSDebug);
return FALSE;
}
/* Is the object at the head of the list */
if (pPrevious == NULL) {
pListHead = pObject->m_pNext;
} else {
pPrevious->m_pNext = pObject->m_pNext;
}
/* Delete the object and update the housekeeping information */
m_dwObjectCount--;
if(pObject->m_wszName) {
DbgLog((LOG_MEMORY,2,TEXT("Object destroyed %d (%ls) %d Active"),
pObject->m_dwCookie, pObject->m_wszName, m_dwObjectCount));
} else {
DbgLog((LOG_MEMORY,2,TEXT("Object destroyed %d (%hs) %d Active"),
pObject->m_dwCookie, pObject->m_szName, m_dwObjectCount));
}
delete pObject;
LeaveCriticalSection(&m_CSDebug);
return TRUE;
}