724 lines
20 KiB
C
724 lines
20 KiB
C
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* Assert.c
|
||
|
|
*
|
||
|
|
* Copyright (c) 1996 Microsoft Corporation. All Rights Reserved.
|
||
|
|
*
|
||
|
|
* Abstract:
|
||
|
|
*
|
||
|
|
* Assertions and squirties.
|
||
|
|
*
|
||
|
|
* Contents:
|
||
|
|
*
|
||
|
|
* SquirtSqflPtszV
|
||
|
|
* AssertPtszPtszLn
|
||
|
|
* ArgsPalPszV
|
||
|
|
* EnterSqflPszPal
|
||
|
|
* ExitSqflPalHresPpv
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
#include "dinputpr.h"
|
||
|
|
|
||
|
|
#ifdef XDEBUG
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* WarnPszV
|
||
|
|
*
|
||
|
|
* Display a message, suitable for framing.
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
#pragma BEGIN_CONST_DATA
|
||
|
|
|
||
|
|
TCHAR c_szPrefix[] = TEXT("DINPUT8: ");
|
||
|
|
|
||
|
|
#pragma END_CONST_DATA
|
||
|
|
|
||
|
|
void EXTERNAL
|
||
|
|
WarnPszV(LPCSTR ptsz, ...)
|
||
|
|
{
|
||
|
|
va_list ap;
|
||
|
|
CHAR sz[1024];
|
||
|
|
|
||
|
|
lstrcpyA(sz, "DINPUT8: ");
|
||
|
|
va_start(ap, ptsz);
|
||
|
|
#ifdef WIN95
|
||
|
|
{
|
||
|
|
char *psz = NULL;
|
||
|
|
char szDfs[1024]={0};
|
||
|
|
strcpy(szDfs,ptsz); // make a local copy of format string
|
||
|
|
while (psz = strstr(szDfs,"%p")) // find each %p
|
||
|
|
*(psz+1) = 'x'; // replace each %p with %x
|
||
|
|
wvsprintfA(sz + cA(c_szPrefix) - 1, szDfs, ap); // use the local format string
|
||
|
|
}
|
||
|
|
#else
|
||
|
|
{
|
||
|
|
wvsprintfA(sz + cA(c_szPrefix) - 1, ptsz, ap);
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
va_end(ap);
|
||
|
|
lstrcatA(sz, "\r\n");
|
||
|
|
OutputDebugStringA(sz);
|
||
|
|
}
|
||
|
|
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifdef DEBUG
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* Globals
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
BYTE g_rgbSqfl[sqflMaxArea];
|
||
|
|
|
||
|
|
extern TCHAR g_tszLogFile[];
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* Sqfl_Init
|
||
|
|
*
|
||
|
|
* Load our initial Sqfl settings from win.ini[debug].
|
||
|
|
*
|
||
|
|
* We take one sqfl for each area, of the form
|
||
|
|
*
|
||
|
|
* dinput.n=v
|
||
|
|
*
|
||
|
|
* where n = 0, ..., sqflMaxArea-1, and where v is one of the
|
||
|
|
* hiword sqfl values.
|
||
|
|
*
|
||
|
|
* The default value for all areas is to squirt only errors.
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
void EXTERNAL
|
||
|
|
Sqfl_Init(void)
|
||
|
|
{
|
||
|
|
int sqfl;
|
||
|
|
TCHAR tsz[20];
|
||
|
|
|
||
|
|
sqfl = 0x0;
|
||
|
|
wsprintf(tsz, TEXT("dinput"));
|
||
|
|
g_rgbSqfl[sqfl] = (BYTE)
|
||
|
|
GetProfileInt(TEXT("DEBUG"), tsz, HIWORD(0x0));
|
||
|
|
|
||
|
|
for (sqfl = 0; sqfl < sqflMaxArea; sqfl++) {
|
||
|
|
wsprintf(tsz, TEXT("dinput.%d"), sqfl);
|
||
|
|
g_rgbSqfl[sqfl] = (BYTE)
|
||
|
|
GetProfileInt(TEXT("DEBUG"), tsz, g_rgbSqfl[0]);
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* SquirtPtsz
|
||
|
|
*
|
||
|
|
* Squirt a message to the debugger and maybe a log file.
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
void INTERNAL
|
||
|
|
SquirtPtsz(LPCTSTR ptsz)
|
||
|
|
{
|
||
|
|
OutputDebugString(ptsz);
|
||
|
|
if (g_tszLogFile[0]) {
|
||
|
|
HANDLE h = CreateFile(g_tszLogFile, GENERIC_WRITE,
|
||
|
|
FILE_SHARE_READ | FILE_SHARE_WRITE,
|
||
|
|
0, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, 0);
|
||
|
|
if (h != INVALID_HANDLE_VALUE) {
|
||
|
|
#ifdef UNICODE
|
||
|
|
CHAR szBuf[1024];
|
||
|
|
#endif
|
||
|
|
SetFilePointer(h, 0, 0, FILE_END);
|
||
|
|
#ifdef UNICODE
|
||
|
|
_lwrite((HFILE)(UINT_PTR)h, szBuf, UToA(szBuf, cA(szBuf), ptsz));
|
||
|
|
#else
|
||
|
|
_lwrite((HFILE)(UINT_PTR)h, ptsz, cbCtch(lstrlen(ptsz)));
|
||
|
|
#endif
|
||
|
|
CloseHandle(h);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* SquirtPtszA
|
||
|
|
*
|
||
|
|
* Squirt an ANSI message to the debugger and maybe a log file.
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
#ifdef UNICODE
|
||
|
|
|
||
|
|
void INTERNAL
|
||
|
|
SquirtPtszA(LPCSTR psz)
|
||
|
|
{
|
||
|
|
OutputDebugStringA(psz);
|
||
|
|
if (g_tszLogFile[0]) {
|
||
|
|
HANDLE h = CreateFile(g_tszLogFile, GENERIC_WRITE,
|
||
|
|
FILE_SHARE_READ | FILE_SHARE_WRITE,
|
||
|
|
0, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, 0);
|
||
|
|
if (h != INVALID_HANDLE_VALUE) {
|
||
|
|
_lwrite((HFILE)(UINT_PTR)h, psz, cbCch(lstrlenA(psz)));
|
||
|
|
CloseHandle(h);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
#else
|
||
|
|
|
||
|
|
#define SquirtPtszA SquirtPtsz
|
||
|
|
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* SquirtSqflPtszV
|
||
|
|
*
|
||
|
|
* Squirt a message with a trailing crlf.
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
void EXTERNAL
|
||
|
|
SquirtSqflPtszV(SQFL sqfl, LPCTSTR ptsz, ...)
|
||
|
|
{
|
||
|
|
if (IsSqflSet(sqfl)) {
|
||
|
|
va_list ap;
|
||
|
|
TCHAR tsz[1024];
|
||
|
|
va_start(ap, ptsz);
|
||
|
|
|
||
|
|
#ifdef WIN95
|
||
|
|
{
|
||
|
|
char *psz = NULL;
|
||
|
|
char szDfs[1024]={0};
|
||
|
|
strcpy(szDfs,ptsz); // make a local copy of format string
|
||
|
|
while (psz = strstr(szDfs,"%p")) // find each %p
|
||
|
|
*(psz+1) = 'x'; // replace each %p with %x
|
||
|
|
wvsprintf(tsz, szDfs, ap); // use the local format string
|
||
|
|
}
|
||
|
|
#else
|
||
|
|
{
|
||
|
|
wvsprintf(tsz, ptsz, ap);
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
va_end(ap);
|
||
|
|
lstrcat(tsz, TEXT("\r\n"));
|
||
|
|
SquirtPtsz(c_szPrefix);
|
||
|
|
SquirtPtsz(tsz);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* AssertPtszPtszLn
|
||
|
|
*
|
||
|
|
* Something bad happened.
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
int EXTERNAL
|
||
|
|
AssertPtszPtszLn(LPCTSTR ptszExpr, LPCTSTR ptszFile, int iLine)
|
||
|
|
{
|
||
|
|
SquirtSqflPtszV(sqflAlways, TEXT("Assertion failed: `%s' at %s(%d)"),
|
||
|
|
ptszExpr, ptszFile, iLine);
|
||
|
|
DebugBreak();
|
||
|
|
return 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* Procedure call tracing is gross because the C preprocessor.
|
||
|
|
*
|
||
|
|
* Oh, if only we had support for m4...
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* dwSafeGetPdw
|
||
|
|
*
|
||
|
|
* Deference a dword, but don't barf if the dword is bad.
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
DWORD INTERNAL
|
||
|
|
dwSafeGetPdw(LPDWORD pdw)
|
||
|
|
{
|
||
|
|
if (IsBadReadPtr(pdw, cbX(*pdw))) {
|
||
|
|
return 0xBAADBAAD;
|
||
|
|
} else {
|
||
|
|
return *pdw;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* ArgsPszV
|
||
|
|
*
|
||
|
|
* Collect arguments to a procedure.
|
||
|
|
*
|
||
|
|
* psz -> ASCIIZ format string
|
||
|
|
* ... = argument list
|
||
|
|
*
|
||
|
|
* The characters in the format string are listed in EmitPal.
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
void EXTERNAL
|
||
|
|
ArgsPalPszV(PARGLIST pal, LPCSTR psz, ...)
|
||
|
|
{
|
||
|
|
va_list ap;
|
||
|
|
va_start(ap, psz);
|
||
|
|
if (psz) {
|
||
|
|
PPV ppv;
|
||
|
|
int i;
|
||
|
|
pal->pszFormat = psz;
|
||
|
|
for (ppv = pal->rgpv, i = 0; i < cpvArgMax, *psz; i++, psz++) {
|
||
|
|
*ppv++ = va_arg(ap, PV);
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
pal->pszFormat = "";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* EmitPal
|
||
|
|
*
|
||
|
|
* OutputDebugString the information, given a pal. No trailing
|
||
|
|
* carriage return is emitted.
|
||
|
|
*
|
||
|
|
* pal -> place where info was saved
|
||
|
|
*
|
||
|
|
* Format characters:
|
||
|
|
*
|
||
|
|
* p - 32 or 64 bit flat pointer
|
||
|
|
* x - 32-bit hex integer
|
||
|
|
* s - TCHAR string
|
||
|
|
* S - SCHAR string
|
||
|
|
* A - ANSI string
|
||
|
|
* W - UNICODE string
|
||
|
|
* G - GUID
|
||
|
|
* u - unsigned integer
|
||
|
|
* C - clipboard format
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
void INTERNAL
|
||
|
|
EmitPal(PARGLIST pal)
|
||
|
|
{
|
||
|
|
char sz[MAX_PATH];
|
||
|
|
int i;
|
||
|
|
SquirtPtsz(c_szPrefix);
|
||
|
|
SquirtPtszA(pal->pszProc);
|
||
|
|
SquirtPtsz(TEXT("("));
|
||
|
|
for (i = 0; pal->pszFormat[i]; i++) {
|
||
|
|
if (i) {
|
||
|
|
SquirtPtsz(TEXT(", "));
|
||
|
|
}
|
||
|
|
switch (pal->pszFormat[i]) {
|
||
|
|
|
||
|
|
case 'p': /* flat pointer */
|
||
|
|
// 7/19/2000(a-JiTay): IA64: Use %p format specifier for 32/64-bit pointers.
|
||
|
|
#ifdef WIN95
|
||
|
|
wsprintfA(sz, "%08x", pal->rgpv[i]);
|
||
|
|
#else
|
||
|
|
wsprintfA(sz, "%p", pal->rgpv[i]);
|
||
|
|
#endif
|
||
|
|
SquirtPtszA(sz);
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'x': /* 32-bit hex */
|
||
|
|
wsprintfA(sz, "%08x", pal->rgpv[i]);
|
||
|
|
SquirtPtszA(sz);
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 's': /* TCHAR string */
|
||
|
|
if (pal->rgpv[i] && lstrlen(pal->rgpv[i])) {
|
||
|
|
SquirtPtsz(pal->rgpv[i]);
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
|
||
|
|
#ifdef UNICODE
|
||
|
|
case 'S': /* SCHAR string */
|
||
|
|
#endif
|
||
|
|
case 'A': /* ANSI string */
|
||
|
|
if (pal->rgpv[i] && lstrlenA(pal->rgpv[i])) {
|
||
|
|
SquirtPtszA(pal->rgpv[i]);
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
|
||
|
|
#ifndef UNICODE
|
||
|
|
case 'S': /* SCHAR string */
|
||
|
|
#endif
|
||
|
|
case 'W': /* UNICODE string */
|
||
|
|
if (pal->rgpv[i] && lstrlenW(pal->rgpv[i])) {
|
||
|
|
#ifdef UNICODE
|
||
|
|
OutputDebugStringW(pal->rgpv[i]);
|
||
|
|
#else
|
||
|
|
UToA(sz, cA(sz), pal->rgpv[i]);
|
||
|
|
SquirtPtszA(sz);
|
||
|
|
#endif
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'G': /* GUID */
|
||
|
|
#if 1
|
||
|
|
wsprintfA(sz, "%08x",
|
||
|
|
HIWORD((DWORD)(UINT_PTR)pal->rgpv[i])
|
||
|
|
? dwSafeGetPdw((LPDWORD)pal->rgpv[i])
|
||
|
|
: (UINT_PTR)pal->rgpv[i]);
|
||
|
|
SquirtPtszA(sz);
|
||
|
|
#else
|
||
|
|
if( HIWORD((DWORD)(UINT_PTR)pal->rgpv[i])
|
||
|
|
&& !(IsBadReadPtr( pal->rgpv[i], cbX(pal->rgpv[i]) ) ) )
|
||
|
|
{
|
||
|
|
NameFromGUID( (PTCHAR)sz, pal->rgpv[i] );
|
||
|
|
#ifdef UNICODE
|
||
|
|
SquirtPtsz( &((PWCHAR)sz)[ctchNamePrefix]);
|
||
|
|
#else
|
||
|
|
SquirtPtszA( &sz[ctchNamePrefix] );
|
||
|
|
#endif
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
wsprintfA(sz, "%08x",(UINT_PTR)pal->rgpv[i]);
|
||
|
|
SquirtPtszA(sz);
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'u': /* 32-bit unsigned decimal */
|
||
|
|
wsprintfA(sz, "%u", pal->rgpv[i]);
|
||
|
|
SquirtPtszA(sz);
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'C':
|
||
|
|
if (GetClipboardFormatNameA((UINT)(UINT_PTR)pal->rgpv[i], sz, cA(sz))) {
|
||
|
|
} else {
|
||
|
|
wsprintfA(sz, "[%04x]", pal->rgpv[i]);
|
||
|
|
}
|
||
|
|
SquirtPtszA(sz);
|
||
|
|
break;
|
||
|
|
|
||
|
|
default: AssertF(! TEXT("Invalid character format code")); /* Invalid */
|
||
|
|
}
|
||
|
|
}
|
||
|
|
SquirtPtsz(TEXT(")"));
|
||
|
|
}
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* EnterSqflPtsz
|
||
|
|
*
|
||
|
|
* Mark entry to a procedure. Arguments were already collected by
|
||
|
|
* ArgsPszV.
|
||
|
|
*
|
||
|
|
* If sqfl contains the sqflBenign flag, then any error we detect
|
||
|
|
* should be classified as sqflBenign and not sqflError.
|
||
|
|
*
|
||
|
|
* sqfl -> squirty flags
|
||
|
|
* pszProc -> procedure name
|
||
|
|
* pal -> place to save the name and get the format/args
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
void EXTERNAL
|
||
|
|
EnterSqflPszPal(SQFL sqfl, LPCSTR pszProc, PARGLIST pal)
|
||
|
|
{
|
||
|
|
pal->pszProc = pszProc;
|
||
|
|
sqfl |= sqflIn;
|
||
|
|
if (IsSqflSet(sqfl)) {
|
||
|
|
EmitPal(pal);
|
||
|
|
SquirtPtsz(TEXT("\r\n"));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
void EXTERNAL
|
||
|
|
ExitSqflPalHresPpv(SQFL sqfl, PARGLIST pal, HRESULT hres, PPV ppvObj)
|
||
|
|
{
|
||
|
|
BOOL fInternalError;
|
||
|
|
SQFL sqflIsError;
|
||
|
|
DWORD le = GetLastError();
|
||
|
|
|
||
|
|
if (sqfl & sqflBenign) {
|
||
|
|
sqfl &= ~sqflBenign;
|
||
|
|
sqflIsError = sqflBenign;
|
||
|
|
} else {
|
||
|
|
sqflIsError = sqflError;
|
||
|
|
}
|
||
|
|
|
||
|
|
sqfl |= sqflOut;
|
||
|
|
fInternalError = 0;
|
||
|
|
if (ppvObj == ppvVoid || ppvObj == ppvDword) {
|
||
|
|
} else if (ppvObj == ppvBool) {
|
||
|
|
if (hres == 0) {
|
||
|
|
sqfl |= sqflIsError;
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
if (FAILED(hres)) {
|
||
|
|
if (fLimpFF(ppvObj && !IsBadWritePtr(ppvObj, cbX(*ppvObj)),
|
||
|
|
*ppvObj == 0)) {
|
||
|
|
} else {
|
||
|
|
fInternalError = 1;
|
||
|
|
}
|
||
|
|
if (hres == E_NOTIMPL) { /* E_NOTIMPL is always benign */
|
||
|
|
sqfl |= sqflBenign;
|
||
|
|
} else {
|
||
|
|
sqfl |= sqflIsError;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if (IsSqflSet(sqfl) || fInternalError) {
|
||
|
|
EmitPal(pal);
|
||
|
|
SquirtPtsz(TEXT(" -> "));
|
||
|
|
if (ppvObj != ppvVoid) {
|
||
|
|
TCHAR tszBuf[32];
|
||
|
|
wsprintf(tszBuf, TEXT("%08x"), hres);
|
||
|
|
SquirtPtsz(tszBuf);
|
||
|
|
if (HIWORD((UINT_PTR)ppvObj)) {
|
||
|
|
wsprintf(tszBuf, TEXT(" [%08x]"),
|
||
|
|
dwSafeGetPdw((LPDWORD)ppvObj));
|
||
|
|
SquirtPtsz(tszBuf);
|
||
|
|
} else if (ppvObj == ppvDword) {
|
||
|
|
wsprintf(tszBuf, TEXT(" [%08x]"), hres);
|
||
|
|
SquirtPtsz(tszBuf);
|
||
|
|
} else if (ppvObj == ppvBool) {
|
||
|
|
wsprintf(tszBuf, hres ? TEXT(" OK ") :
|
||
|
|
TEXT(" le=[%d]"), le);
|
||
|
|
SquirtPtsz(tszBuf);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
SquirtPtsz(TEXT("\r\n"));
|
||
|
|
AssertF(!fInternalError);
|
||
|
|
}
|
||
|
|
|
||
|
|
/*
|
||
|
|
* This redundant test prevents a breakpoint on SetLastError()
|
||
|
|
* from being hit constantly.
|
||
|
|
*/
|
||
|
|
if (le != GetLastError()) {
|
||
|
|
SetLastError(le);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifdef XDEBUG
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* @doc INTERNAL
|
||
|
|
*
|
||
|
|
* @func DWORD | Random |
|
||
|
|
*
|
||
|
|
* Returns a pseudorandom dword. The value doesn't need to be
|
||
|
|
* statistically wonderful.
|
||
|
|
*
|
||
|
|
* @returns
|
||
|
|
* A not very random dword.
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
DWORD s_dwRandom = 1; /* Random number seed */
|
||
|
|
|
||
|
|
DWORD INLINE
|
||
|
|
Random(void)
|
||
|
|
{
|
||
|
|
s_dwRandom = s_dwRandom * 214013 + 2531011;
|
||
|
|
return s_dwRandom;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* @doc INTERNAL
|
||
|
|
*
|
||
|
|
* @func void | ScrambleBuf |
|
||
|
|
*
|
||
|
|
* Fill a buffer with garbage. Used in RDEBUG to make sure
|
||
|
|
* the caller is not relying on buffer data.
|
||
|
|
*
|
||
|
|
* Note: If the buffer is not a multiple of dwords in size,
|
||
|
|
* the leftover bytes are not touched.
|
||
|
|
*
|
||
|
|
* @parm OUT LPVOID | pv |
|
||
|
|
*
|
||
|
|
* The buffer to be scrambled.
|
||
|
|
*
|
||
|
|
* @parm UINT | cb |
|
||
|
|
*
|
||
|
|
* The size of the buffer.
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
void EXTERNAL
|
||
|
|
ScrambleBuf(LPVOID pv, UINT cb)
|
||
|
|
{
|
||
|
|
UINT idw;
|
||
|
|
UINT cdw = cb / 4;
|
||
|
|
LPDWORD pdw = pv;
|
||
|
|
for (idw = 0; idw < cdw; idw++) {
|
||
|
|
pdw[idw] = Random();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* @doc INTERNAL
|
||
|
|
*
|
||
|
|
* @func void | ScrambleBit |
|
||
|
|
*
|
||
|
|
* Randomly set or clear a bit.
|
||
|
|
*
|
||
|
|
* @parm OUT LPDWORD | pdw |
|
||
|
|
*
|
||
|
|
* The dword whose bit is to be set randomly.
|
||
|
|
*
|
||
|
|
* @parm UINT | flMask |
|
||
|
|
*
|
||
|
|
* Mask for the bits to scramble.
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
void EXTERNAL ScrambleBit(LPDWORD pdw, DWORD flMask)
|
||
|
|
{
|
||
|
|
*pdw ^= (*pdw ^ Random()) & flMask;
|
||
|
|
}
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* @doc INTERNAL
|
||
|
|
*
|
||
|
|
* @func BOOL | Callback_CompareContexts |
|
||
|
|
*
|
||
|
|
* Check if two <t CONTEXT> structures are substantially the same
|
||
|
|
* to the extent required by the Win32 calling convention.
|
||
|
|
*
|
||
|
|
* This is necessary because lots of applications pass
|
||
|
|
* incorrectly prototyped functions as callbacks. Others will
|
||
|
|
* write callback functions that trash registers that are
|
||
|
|
* supposed to be nonvolatile.
|
||
|
|
*
|
||
|
|
* NOTE! Platform-dependent code!
|
||
|
|
*
|
||
|
|
* @parm LPCONTEXT | pctx1 |
|
||
|
|
*
|
||
|
|
* Context structure before we call the callback.
|
||
|
|
*
|
||
|
|
* @parm LPCONTEXT | pctx2 |
|
||
|
|
*
|
||
|
|
* Context structure after we call the callback.
|
||
|
|
*
|
||
|
|
* @returns
|
||
|
|
*
|
||
|
|
* Nonzero if the two contexts are substantially the same.
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
BOOL INLINE
|
||
|
|
Callback_CompareContexts(LPCONTEXT pctx1, LPCONTEXT pctx2)
|
||
|
|
{
|
||
|
|
#if defined(_X86_)
|
||
|
|
return pctx1->Esp == pctx2->Esp; /* Stack pointer */
|
||
|
|
#if 0
|
||
|
|
/*
|
||
|
|
* Can't test these registers because Win95 doesn't preserve
|
||
|
|
* them properly. GetThreadContext() stashes what happens to
|
||
|
|
* be in the registers when you finally reach the bowels of
|
||
|
|
* kernel, at which point who knows what they contain...
|
||
|
|
*/
|
||
|
|
pctx1->Ebx == pctx2->Ebx && /* Nonvolatile registers */
|
||
|
|
pctx1->Esi == pctx2->Esi &&
|
||
|
|
pctx1->Edi == pctx2->Edi &&
|
||
|
|
pctx1->Ebp == pctx2->Ebp;
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#elif defined(_AMD64_)
|
||
|
|
|
||
|
|
return pctx1->Rbx == pctx2->Rbx &&
|
||
|
|
pctx1->Rbp == pctx2->Rbp &&
|
||
|
|
pctx1->Rsp == pctx2->Rsp &&
|
||
|
|
pctx1->Rdi == pctx2->Rdi &&
|
||
|
|
pctx1->Rsi == pctx2->Rsi &&
|
||
|
|
pctx1->R12 == pctx2->R12 &&
|
||
|
|
pctx1->R13 == pctx2->R13 &&
|
||
|
|
pctx1->R14 == pctx2->R14 &&
|
||
|
|
pctx1->R15 == pctx2->R15;
|
||
|
|
|
||
|
|
#elif defined(_IA64_)
|
||
|
|
|
||
|
|
return pctx1->IntSp == pctx2->IntSp && /* Stack pointer */
|
||
|
|
pctx1->RsBSP == pctx2->RsBSP && /* Backing store pointer */
|
||
|
|
pctx1->IntS0 == pctx2->IntS0 && /* Nonvolatile registers */
|
||
|
|
pctx1->IntS1 == pctx2->IntS1 &&
|
||
|
|
pctx1->IntS2 == pctx2->IntS2 &&
|
||
|
|
pctx1->IntS3 == pctx2->IntS3;
|
||
|
|
|
||
|
|
#else
|
||
|
|
#error "No Target Architecture"
|
||
|
|
#endif
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
/*****************************************************************************
|
||
|
|
*
|
||
|
|
* @doc INTERNAL
|
||
|
|
*
|
||
|
|
* @func BOOL | Callback |
|
||
|
|
*
|
||
|
|
* Perform a callback the paranoid way, checking that the
|
||
|
|
* application used the correct calling convention and preserved
|
||
|
|
* all nonvolatile registers.
|
||
|
|
*
|
||
|
|
* NOTE! Platform-dependent code!
|
||
|
|
*
|
||
|
|
* @parm DICALLBACKPROC | pfn |
|
||
|
|
*
|
||
|
|
* Procedure to call back.
|
||
|
|
*
|
||
|
|
* @parm PV | pv1 |
|
||
|
|
*
|
||
|
|
* First parameter to callback.
|
||
|
|
*
|
||
|
|
* @parm PV | pv2 |
|
||
|
|
*
|
||
|
|
* Second parameter to callback.
|
||
|
|
*
|
||
|
|
* @returns
|
||
|
|
*
|
||
|
|
* Whatever the callback returns.
|
||
|
|
*
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
BOOL EXTERNAL
|
||
|
|
Callback(DICALLBACKPROC pfn, PV pv1, PV pv2)
|
||
|
|
{
|
||
|
|
CONTEXT ctxPre; /* Thread context before call */
|
||
|
|
CONTEXT ctxPost; /* Thread context after call */
|
||
|
|
volatile BOOL fRc; /* To prevent compiler from enregistering */
|
||
|
|
|
||
|
|
/* Get state of registers before the callback */
|
||
|
|
ctxPre.ContextFlags = CONTEXT_CONTROL | CONTEXT_INTEGER;
|
||
|
|
GetThreadContext(GetCurrentThread(), &ctxPre);
|
||
|
|
|
||
|
|
fRc = pfn(pv1, pv2);
|
||
|
|
|
||
|
|
ctxPost.ContextFlags = CONTEXT_CONTROL | CONTEXT_INTEGER;
|
||
|
|
if (GetThreadContext(GetCurrentThread(), &ctxPost) &&
|
||
|
|
!Callback_CompareContexts(&ctxPre, &ctxPost)) {
|
||
|
|
RPF("Incorrectly prototyped callback! Crash soon!");
|
||
|
|
ValidationException();
|
||
|
|
}
|
||
|
|
|
||
|
|
return fRc;
|
||
|
|
}
|
||
|
|
|
||
|
|
#endif
|