EM_Task/TraceInsights/Private/Insights/StoreService/StoreBrowser.h

// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include "Async/AsyncWork.h"
#include "CoreMinimal.h"
#include "HAL/Runnable.h"
#include "HAL/RunnableThread.h"
#include "HAL/ThreadSafeBool.h"
#include "HAL/CriticalSection.h"
#include "Templates/Atomic.h"

namespace Trace
{
class FStoreClient;
}

namespace Insights
{

////////////////////////////////////////////////////////////////////////////////////////////////////

struct FStoreBrowserTraceInfo
{
    uint32 TraceId      = 0;

    uint64 ChangeSerial = 0;
    int32 TraceIndex    = -1;

    FString Name;
    // FString Uri;

    FDateTime Timestamp     = 0;
    uint64 Size             = 0;

    bool bIsLive            = false;
    uint32 IpAddress        = 0;

    bool bIsMetadataUpdated = false;
    FString Platform;
    FString AppName;
    FString CommandLine;
    EBuildConfiguration ConfigurationType = EBuildConfiguration::Unknown;
    EBuildTargetType TargetType           = EBuildTargetType::Unknown;

    FStoreBrowserTraceInfo()              = default;

    static FDateTime ConvertTimestamp(uint64 InTimestamp)
    {
        return FDateTime(static_cast<int64>(InTimestamp));
    }
};

////////////////////////////////////////////////////////////////////////////////////////////////////

class FStoreBrowser: public FRunnable
{
    friend class FStoreBrowserUpdaterAsyncTask;

public:
    FStoreBrowser();
    virtual ~FStoreBrowser();

    //////////////////////////////////////////////////
    // FRunnable interface

    virtual bool Init() override;
    virtual uint32 Run() override;
    virtual void Stop() override;
    virtual void Exit() override;

    //////////////////////////////////////////////////

    bool IsRunning() const { return bRunning; }

    bool IsLocked() const { return bTracesLocked; }
    void Lock()
    {
        check(!bTracesLocked);
        bTracesLocked = true;
        TracesCriticalSection.Lock();
    }
    uint64 GetLockedTracesChangeSerial() const
    {
        check(bTracesLocked);
        return TracesChangeSerial;
    }
    const TArray<TSharedPtr<FStoreBrowserTraceInfo>>& GetLockedTraces() const
    {
        check(bTracesLocked);
        return Traces;
    }
    const TMap<uint32, TSharedPtr<FStoreBrowserTraceInfo>>& GetLockedTraceMap() const
    {
        check(bTracesLocked);
        return TraceMap;
    }
    void Unlock()
    {
        check(bTracesLocked);
        bTracesLocked = false;
        TracesCriticalSection.Unlock();
    }

private:
    Trace::FStoreClient* GetStoreClient() const;

    void UpdateTraces();
    void ResetTraces();

    void UpdateMetadata(FStoreBrowserTraceInfo& TraceSession);

private:
    // Thread safe bool for stopping the thread
    FThreadSafeBool bRunning;

    // Thread for continously updating and caching info about trace store.
    FRunnableThread* Thread;

    mutable FCriticalSection TracesCriticalSection;
    FThreadSafeBool bTracesLocked;  // for debugging, to ensure GetLocked*() methods are only called between Lock() - Unlock() calls.
    uint32 StoreChangeSerial;
    uint64 TracesChangeSerial;
    TArray<TSharedPtr<FStoreBrowserTraceInfo>> Traces;
    TMap<uint32, TSharedPtr<FStoreBrowserTraceInfo>> TraceMap;
    TMap<uint32, TSharedPtr<FStoreBrowserTraceInfo>> LiveTraceMap;
};

////////////////////////////////////////////////////////////////////////////////////////////////////

}  // namespace Insights