mirror of https://github.com/lianthony/NT4.0
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
252 lines
6.5 KiB
252 lines
6.5 KiB
/*++
|
|
|
|
Copyright (c) 1994 Microsoft Corporation
|
|
|
|
Module Name :
|
|
|
|
dbgutil.h
|
|
|
|
Abstract:
|
|
|
|
This module declares the macros to wrap around DEBUG_PRINTS class.
|
|
This is the exported header file, which the client is allowed to
|
|
modify for each application the accompanying pgmutils.dll/obj is used.
|
|
|
|
Author:
|
|
|
|
Murali R. Krishnan ( MuraliK ) 21-Feb-1995
|
|
|
|
Project:
|
|
W3 Server DLL
|
|
|
|
Revision History:
|
|
--*/
|
|
|
|
# ifndef _DBGUTIL_H_
|
|
# define _DBGUTIL_H_
|
|
|
|
|
|
// begin_user_modifiable
|
|
|
|
//
|
|
// Modify the following flags if necessary
|
|
//
|
|
|
|
# define DEFAULT_OUTPUT_FLAGS ( DbgOutputKdb | DbgOutputLogFile )
|
|
|
|
|
|
// end_user_modifiable
|
|
// begin_user_unmodifiable
|
|
|
|
|
|
# if DBG
|
|
|
|
/************************************************************
|
|
* Include Headers
|
|
************************************************************/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
# include <nt.h>
|
|
# include <ntrtl.h>
|
|
# include <nturtl.h>
|
|
|
|
# include <windows.h>
|
|
|
|
#ifdef __cplusplus
|
|
};
|
|
#endif // __cplusplus
|
|
|
|
|
|
# include <pudebug.h>
|
|
|
|
/***********************************************************
|
|
* Macros
|
|
************************************************************/
|
|
|
|
|
|
extern DEBUG_PRINTS * g_pDebug; // define a global debug variable
|
|
|
|
|
|
# define DECLARE_DEBUG_PRINTS_OBJECT() \
|
|
DEBUG_PRINTS * g_pDebug = NULL;
|
|
|
|
|
|
//
|
|
// Call the following macro as part of your initialization for program
|
|
// planning to use the debugging class.
|
|
//
|
|
# define CREATE_DEBUG_PRINT_OBJECT( pszLabel) \
|
|
g_pDebug = PuCreateDebugPrintsObject( pszLabel, DEFAULT_OUTPUT_FLAGS);\
|
|
if ( g_pDebug == NULL) { \
|
|
OutputDebugString( "Unable to Create Debug Print Object \n"); \
|
|
}
|
|
|
|
//
|
|
// Call the following macro once as part of the termination of program
|
|
// which uses the debugging class.
|
|
//
|
|
# define DELETE_DEBUG_PRINT_OBJECT( ) \
|
|
g_pDebug = PuDeleteDebugPrintsObject( g_pDebug);
|
|
|
|
|
|
# define VALID_DEBUG_PRINT_OBJECT() \
|
|
( ( g_pDebug != NULL) && g_pDebug->m_fInitialized)
|
|
|
|
|
|
//
|
|
// Use the DBG_CONTEXT without any surrounding braces.
|
|
// This is used to pass the values for global DebugPrintObject
|
|
// and File/Line information
|
|
//
|
|
# define DBG_CONTEXT g_pDebug, __FILE__, __LINE__
|
|
|
|
|
|
|
|
# define DBG_CODE(s) s /* echoes code in debugging mode */
|
|
|
|
|
|
# define DBG_ASSERT( exp) if ( !(exp)) { \
|
|
PuDbgAssertFailed( DBG_CONTEXT, #exp, NULL); \
|
|
} else {}
|
|
|
|
# define DBG_ASSERT_MSG( exp, pszMsg) \
|
|
if ( !(exp)) { \
|
|
PuDbgAssertFailed( DBG_CONTEXT, #exp, pszMsg); \
|
|
} else {}
|
|
|
|
# define DBG_REQUIRE( exp) DBG_ASSERT( exp)
|
|
|
|
# define DBG_LOG() PuDbgPrint( DBG_CONTEXT, "\n")
|
|
|
|
# define DBG_OPEN_LOG_FILE( pszFile, pszPath) \
|
|
PuOpenDbgPrintFile( g_pDebug, (pszFile), (pszPath))
|
|
|
|
# define DBG_CLOSE_LOG_FILE( ) \
|
|
PuCloseDbgPrintFile( g_pDebug)
|
|
|
|
# define SET_DEBUG_PRINT_FLAGS( dwFlags) \
|
|
PuSetDbgOutputFlags( g_pDebug, (dwFlags))
|
|
|
|
# define GET_DEBUG_PRINT_FLAGS() \
|
|
PuGetDbgOutputFlags( g_pDebug)
|
|
|
|
|
|
//
|
|
// DBGPRINTF() is printing function ( much like printf) but always called
|
|
// with the DBG_CONTEXT as follows
|
|
// DBGPRINTF( ( DBG_CONTEXT, format-string, arguments for format list);
|
|
//
|
|
# define DBGPRINTF( args) PuDbgPrint args
|
|
|
|
# else // DBG
|
|
|
|
|
|
# define DECLARE_DEBUG_PRINTS_OBJECT() /* Do Nothing */
|
|
# define CREATE_DEBUG_PRINT_OBJECT( pszLabel) /* Do Nothing */
|
|
# define DELETE_DEBUG_PRINT_OBJECT( ) /* Do Nothing */
|
|
# define VALID_DEBUG_PRINT_OBJECT() ( TRUE)
|
|
|
|
# define DBG_CODE(s) /* Do Nothing */
|
|
|
|
# define DBG_ASSERT(exp) /* Do Nothing */
|
|
|
|
# define DBG_ASSERT_MSG(exp, pszMsg) /* Do Nothing */
|
|
|
|
# define DBG_REQUIRE( exp) ( (void) (exp))
|
|
|
|
# define DBGPRINTF( args) /* Do Nothing */
|
|
|
|
# define SET_DEBUG_PRINT_FLAGS( dwFlags) /* Do Nothing */
|
|
# define GET_DEBUG_PRINT_FLAGS( ) ( 0)
|
|
|
|
# define DBG_LOG() /* Do Nothing */
|
|
|
|
# define DBG_OPEN_LOG_FILE( pszFile, pszPath) /* Do Nothing */
|
|
|
|
# define DBG_CLOSE_LOG_FILE() /* Do Nothing */
|
|
|
|
# endif // DBG
|
|
|
|
|
|
// end_user_modifiable
|
|
// begin_user_unmodifiable
|
|
|
|
|
|
|
|
//
|
|
// Define the debugging constants
|
|
//
|
|
|
|
# define DEBUG_SERVICE_CTRL 0x00000001
|
|
# define DEBUG_TIMING 0x00000002
|
|
# define DEBUG_CACHE 0x00000004
|
|
# define DEBUG_ERROR 0x00000008
|
|
|
|
# define DEBUG_COMMANDS 0x00000010
|
|
# define DEBUG_PARSING 0x00000020
|
|
# define DEBUG_REQUEST 0x00000040
|
|
# define DEBUG_GD_REQUEST_LOG 0x00000080
|
|
|
|
# define DEBUG_CLIENT 0x00000100
|
|
# define DEBUG_CONNECTION 0x00000200
|
|
# define DEBUG_CONFIG 0x00000400
|
|
# define DEBUG_SECURITY 0x00000800
|
|
|
|
# define DEBUG_SOCKETS 0x00001000
|
|
# define DEBUG_STATISTICS 0x00002000
|
|
# define DEBUG_RPC 0x00004000
|
|
|
|
# define DEBUG_CGI 0x00010000L
|
|
# define DEBUG_BGI 0x00020000L
|
|
# define DEBUG_MIME 0x00040000L
|
|
# define DEBUG_SSI 0x00080000L
|
|
|
|
|
|
# if DBG
|
|
|
|
extern DWORD g_dwDebugFlags; // Debugging Flags
|
|
|
|
# define DECLARE_DEBUG_VARIABLE() \
|
|
DWORD g_dwDebugFlags
|
|
|
|
# define SET_DEBUG_FLAGS( dwFlags) g_dwDebugFlags = dwFlags
|
|
# define GET_DEBUG_FLAGS() ( g_dwDebugFlags)
|
|
|
|
# define DEBUG_IF( arg, s) if ( DEBUG_ ## arg & GET_DEBUG_FLAGS()) { \
|
|
s \
|
|
} else {}
|
|
|
|
# define IF_DEBUG( arg) if ( DEBUG_ ## arg & GET_DEBUG_FLAGS())
|
|
|
|
|
|
# else // DBG
|
|
|
|
|
|
# define DECLARE_DEBUG_VARIABLE() /* Do Nothing */
|
|
# define SET_DEBUG_FLAGS( dwFlags) /* Do Nothing */
|
|
# define GET_DEBUG_FLAGS() ( 0)
|
|
|
|
# define DEBUG_IF( arg, s) /* Do Nothing */
|
|
# define IF_DEBUG( arg) if ( 0)
|
|
|
|
# endif // DBG
|
|
|
|
|
|
|
|
//
|
|
// Specific macros for W3 svcs module
|
|
//
|
|
# define TCP_PRINT DBGPRINTF
|
|
# define TCP_ASSERT( exp) DBG_ASSERT( exp)
|
|
# define TCP_REQUIRE( exp) DBG_REQUIRE( exp)
|
|
|
|
|
|
|
|
# endif /* _DBGUTIL_H_ */
|
|
|
|
/************************ End of File ***********************/
|
|
|