77 lines
2.8 KiB
C++
77 lines
2.8 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- tracing.hpp
|
|
|
|
Abstract:
|
|
- This module is used for recording tracing/debugging information to the telemetry ETW channel
|
|
- The data is not automatically broadcast to telemetry backends as it does not set the TELEMETRY keyword.
|
|
- NOTE: Many functions in this file appear to be copy/pastes. This is because the TraceLog documentation warns
|
|
to not be "cute" in trying to reduce its macro usages with variables as it can cause unexpected behavior.
|
|
|
|
Author(s):
|
|
- Michael Niksa (miniksa) 25-Nov-2014
|
|
--*/
|
|
|
|
#pragma once
|
|
|
|
#include <functional>
|
|
|
|
#include "../types/inc/Viewport.hpp"
|
|
|
|
#if DBG
|
|
#define DBGCHARS(_params_) \
|
|
{ \
|
|
Tracing::s_TraceChars _params_; \
|
|
}
|
|
#define DBGOUTPUT(_params_) \
|
|
{ \
|
|
Tracing::s_TraceOutput _params_; \
|
|
}
|
|
#else
|
|
#define DBGCHARS(_params_)
|
|
#define DBGOUTPUT(_params_)
|
|
#endif
|
|
|
|
class Tracing
|
|
{
|
|
public:
|
|
~Tracing();
|
|
|
|
static Tracing s_TraceApiCall(const NTSTATUS result, PCSTR traceName);
|
|
|
|
static void s_TraceApi(const NTSTATUS status, const CONSOLE_GETLARGESTWINDOWSIZE_MSG* const a);
|
|
static void s_TraceApi(const NTSTATUS status, const CONSOLE_SCREENBUFFERINFO_MSG* const a, const bool fSet);
|
|
static void s_TraceApi(const NTSTATUS status, const CONSOLE_SETSCREENBUFFERSIZE_MSG* const a);
|
|
static void s_TraceApi(const NTSTATUS status, const CONSOLE_SETWINDOWINFO_MSG* const a);
|
|
|
|
static void s_TraceApi(_In_ const void* const buffer, const CONSOLE_WRITECONSOLE_MSG* const a);
|
|
|
|
static void s_TraceApi(const CONSOLE_SCREENBUFFERINFO_MSG* const a);
|
|
static void s_TraceApi(const CONSOLE_MODE_MSG* const a, const std::wstring_view handleType);
|
|
static void s_TraceApi(const CONSOLE_SETTEXTATTRIBUTE_MSG* const a);
|
|
static void s_TraceApi(const CONSOLE_WRITECONSOLEOUTPUTSTRING_MSG* const a);
|
|
|
|
static void s_TraceWindowViewport(const Microsoft::Console::Types::Viewport& viewport);
|
|
|
|
static void s_TraceChars(_In_z_ const char* pszMessage, ...);
|
|
static void s_TraceOutput(_In_z_ const char* pszMessage, ...);
|
|
|
|
static void s_TraceWindowMessage(const MSG& msg);
|
|
static void s_TraceInputRecord(const INPUT_RECORD& inputRecord);
|
|
|
|
static void s_TraceCookedRead(_In_ ConsoleProcessHandle* const pConsoleProcessHandle, _In_reads_(cchCookedBufferLength) const wchar_t* pwchCookedBuffer, _In_ ULONG cchCookedBufferLength);
|
|
static void s_TraceConsoleAttachDetach(_In_ ConsoleProcessHandle* const pConsoleProcessHandle, _In_ bool bIsAttach);
|
|
|
|
static void __stdcall TraceFailure(const wil::FailureInfo& failure) noexcept;
|
|
|
|
private:
|
|
static ULONG s_ulDebugFlag;
|
|
|
|
Tracing(std::function<void()> onExit);
|
|
|
|
std::function<void()> _onExit;
|
|
};
|