MddBootstrapTracelogging.h

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See LICENSE in the project root for license information.

#pragma once

#include "pch.h"

bool __stdcall wilResultLoggingThreadCallback(const wil::FailureInfo& failure) noexcept;

GUID& GetLifetimeActivityId() noexcept;

class WindowsAppRuntimeBootstrap_TraceLogger final : public wil::TraceLoggingProvider
{
    IMPLEMENT_TRACELOGGING_CLASS(
        WindowsAppRuntimeBootstrap_TraceLogger,
        "Microsoft.WindowsAppRuntime.MddBootstrap",
        // {d71ecd75-2924-589c-16dd-68208d1b4015}
        (0xd71ecd75, 0x2924, 0x589c, 0x16, 0xdd, 0x68, 0x20, 0x8d, 0x1b, 0x40, 0x15));

public:
    BEGIN_COMPLIANT_CRITICAL_DATA_ACTIVITY_CLASS(Initialize, PDT_ProductAndServicePerformance);
    void StartActivity(
        UINT32 majorMinorVersion,
        PCWSTR versionTag,
        PACKAGE_VERSION minVersion,
        UINT32 mddInitializeOptions,
        UINT32 initializationCount)
    {
        // Set lifetime activity Id that helps in corelating all sub-activities/telemetry from a single Mdd Bootstrap lifetime
        SetRelatedActivityId(GetLifetimeActivityId());

        TraceLoggingClassWriteStart(Initialize,
            _GENERIC_PARTB_FIELDS_ENABLED,
            TraceLoggingValue(majorMinorVersion, "majorMinorVersion"),
            TraceLoggingValue(!versionTag ? L"": versionTag, "versionTag"),
            TraceLoggingValue(minVersion.Version, "minVersion"),
            TraceLoggingValue(mddInitializeOptions, "mddInitializeOptions"),
            TraceLoggingValue(initializationCount, "initializationCount"));
    }
    void StopWithResult(
        const HRESULT hresult,
        UINT32 initializationCount,
        UINT32 IntegrityFlags,
        PWSTR resolvedFrameworkPackageFullName,
        UINT32 failureType,
        PCSTR failureFile,
        unsigned int failureLineNumber,
        PCWSTR failureMessage,
        PCSTR failureModule)
    {
        SetStopResult(hresult);

        if (hresult)
        {
            TraceLoggingClassWriteStop(Initialize,
                _GENERIC_PARTB_FIELDS_ENABLED,
                TraceLoggingValue(initializationCount, "initializationCount"),
                TraceLoggingValue(IntegrityFlags, "IntegrityFlags"),
                TraceLoggingValue(resolvedFrameworkPackageFullName, "resolvedFrameworkPackageFullName"),
                TraceLoggingValue(failureType, "wilFailureType"),
                TraceLoggingValue(failureFile, "failureFile"),
                TraceLoggingValue(failureLineNumber, "failureLineNumber"),
                TraceLoggingValue(failureMessage, "failureMessage"),
                TraceLoggingValue(failureModule, "failureModule"));
        }
        else
        {
            TraceLoggingClassWriteStop(Initialize,
                _GENERIC_PARTB_FIELDS_ENABLED,
                TraceLoggingValue(initializationCount, "initializationCount"),
                TraceLoggingValue(IntegrityFlags, "IntegrityFlags"),
                TraceLoggingValue(resolvedFrameworkPackageFullName, "resolvedFrameworkPackageFullName"));
        }
    }
    END_ACTIVITY_CLASS();


    BEGIN_COMPLIANT_CRITICAL_DATA_ACTIVITY_CLASS(Shutdown, PDT_ProductAndServicePerformance);
    void StartActivity(
        UINT32 initializationCount,
        PWSTR resolvedFrameworkPackageFullName)
    {
        // Set lifetime activity Id that helps in corelating all sub-activities/telemetry from a single Mdd Bootstrap lifetime
        SetRelatedActivityId(GetLifetimeActivityId());

        TraceLoggingClassWriteStart(Shutdown,
            _GENERIC_PARTB_FIELDS_ENABLED,
            TraceLoggingValue(initializationCount, "initializationCount"),
            TraceLoggingValue(resolvedFrameworkPackageFullName, "resolvedFrameworkPackageFullName"));
    }
    void StopWithResult(
        HRESULT hresult,
        UINT32 initializationCount,
        UINT32 failureType,
        PCSTR failureFile,
        unsigned int failureLineNumber,
        PCWSTR failureMessage,
        PCSTR failureModule)
    {
        SetStopResult(hresult);

        if (hresult)
        {
            TraceLoggingClassWriteStop(Shutdown,
                _GENERIC_PARTB_FIELDS_ENABLED,
                TraceLoggingValue(initializationCount, "initializationCount"),
                TraceLoggingValue(failureType, "WilFailureType"),
                TraceLoggingValue(failureFile, "FailureFile"),
                TraceLoggingValue(failureLineNumber, "FailureLineNumber"),
                TraceLoggingValue(failureMessage, "FailureMessage"),
                TraceLoggingValue(failureModule, "FailureModule"));
        }
        else
        {
            TraceLoggingClassWriteStop(Shutdown,
                _GENERIC_PARTB_FIELDS_ENABLED,
                TraceLoggingValue(initializationCount, "initializationCount"));
        }
    }
    END_ACTIVITY_CLASS();
};

#define MddBootstrap_TraceLoggingWString(_wstring_, _name_) TraceLoggingCountedWideString(_wstring_.c_str(),\
     static_cast<ULONG>(_wstring_.size()), _name_)

// In the future, if the project includes multiple modules and threads, we could log that data as well from FailureInfo
// In the future and on need basis, we could log call stack as well
#define MddBootstrap_WriteEventWithActivity(_eventname_,_activityId_,...) TraceLoggingWriteActivity(\
        WindowsAppRuntimeBootstrap_TraceLogger::Provider(),\
        _eventname_,\
        _activityId_,\
        nullptr,\
        _WRITE_FAILURE_INFO,\
        __VA_ARGS__)

#define _WRITE_FAILURE_INFO \
    TraceLoggingValue(static_cast<uint32_t>(failure.type), "Type"),\
    TraceLoggingValue(failure.hr, "HResult"),\
    TraceLoggingValue(failure.pszFile, "File"),\
    TraceLoggingValue(failure.uLineNumber,"Line"),\
    TraceLoggingValue(failure.pszModule, "Module"),\
    TraceLoggingValue(failure.pszMessage,"Message")