Common tracing definitions for Windows drivers. #windows #driver

Trace.h

//
// The MIT License (MIT)
//
// Copyright (c) 2013-2014 Max Truxa
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//

#define TRACE_LEVEL_ERROR           DPFLTR_ERROR_LEVEL
#define TRACE_LEVEL_WARNING         DPFLTR_WARNING_LEVEL
#define TRACE_LEVEL_TRACE           DPFLTR_TRACE_LEVEL
#define TRACE_LEVEL_INFORMATION     DPFLTR_INFO_LEVEL

#define _TRACE_STRINGIZE2(_Token)   #_Token
#define _TRACE_STRINGIZE(_Token)    _TRACE_STRINGIZE2(_Token)

#ifndef TRACE_PREFIX
#define TRACE_PREFIX                __FILE__ "(" _TRACE_STRINGIZE(__LINE__) ")!" __FUNCTION__ " - "
#endif

#ifdef DBG
// Output message to the kernel debugger, prefixing the message with driver specific data.
#define Trace(_Level, _Format, ...)     DbgPrintEx(DPFLTR_IHVDRIVER_ID, _Level, TRACE_PREFIX _Format "\n", __VA_ARGS__)
#else
// Do nothing.
#define Trace(_Level, ...)              UNREFERENCED_PARAMETER((_Level, __VA_ARGS__))
#endif