UnrealEngineUWP/Engine/Source/Developer/TraceAnalysis/Private/Analysis/Engine.h

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

#pragma once

#include "Containers/Array.h"
#include "Trace/Analysis.h"
#include "Trace/Analyzer.h"

namespace UE {
namespace Trace {

struct FAuxDataCollector;
struct FDispatch;
class FDispatchBuilder;
class FStreamReader;

////////////////////////////////////////////////////////////////////////////////
class FThreads
{
public:
	struct FInfo
	{
		TArray<uint64>	ScopeRoutes;
		TArray<uint8>	Name;
		TArray<uint8>	GroupName;
		int64			PrevTimestamp = 0;
		uint32			ThreadId = ~0u;
		uint32			SystemId = 0;
		int32			SortHint = 0xff;
	};

						FThreads();
						~FThreads();
	FInfo*				GetInfo();
	FInfo*				GetInfo(uint32 ThreadId);
	void				SetGroupName(const ANSICHAR* InGroupName, uint32 Length);
	const TArray<uint8>*GetGroupName() const;

private:
	uint32				LastGetInfoId = ~0u;
	TArray<FInfo*>		Infos;
	TArray<uint8>		GroupName;
};



////////////////////////////////////////////////////////////////////////////////
struct FTiming
{
	uint64	BaseTimestamp;
	uint64	TimestampHz;
	double	InvTimestampHz;
	uint64	EventTimestamp = 0;
};



////////////////////////////////////////////////////////////////////////////////
class FAnalysisEngine
	: public IAnalyzer
{
public:
						FAnalysisEngine(TArray<IAnalyzer*>&& InAnalyzers);
						~FAnalysisEngine();
	bool				OnData(FStreamReader& Reader);
	void				End();

private:
	typedef bool (FAnalysisEngine::*ProtocolHandlerType)();

	struct FRoute
	{
		uint32			Hash;
		uint16			AnalyzerIndex : 15;
		uint16			bScoped : 1;
		uint16			Id;
		union
		{
			uint32		ParentHash;
			struct
			{
				int16	Count;
				int16	Parent;
			};
		};
	};

	void				Begin();
	virtual bool		OnEvent(uint16 RouteId, EStyle Style, const FOnEventContext& Context) override;
	virtual void		OnAnalysisBegin(const FOnAnalysisContext& Context) override;
	void				OnNewTrace(const FOnEventContext& Context);
	void				OnSerialSync(const FOnEventContext& Context);
	void				OnThreadTiming(const FOnEventContext& Context);
	void				OnThreadInfoInternal(const FOnEventContext& Context);
	void				OnThreadGroupBegin(const FOnEventContext& Context);
	void				OnThreadGroupEnd();
	void				OnTiming(const FOnEventContext& Context);
	void				OnNewEventInternal(const void* EventData);
	void				OnNewEventProtocol0(FDispatchBuilder& Builder, const void* EventData);
	void				OnNewEventProtocol1(FDispatchBuilder& Builder, const void* EventData);
	bool				EstablishTransport(FStreamReader& Reader);
	bool				OnDataProtocol0();
	bool				OnDataProtocol2();
	int32				OnDataProtocol2(FStreamReader& Reader, FThreads::FInfo& Info);
	int32				OnDataProtocol2Aux(FStreamReader& Reader, FAuxDataCollector& Collector);
	int32				OnDataProtocol4(FStreamReader& Reader, FThreads::FInfo& Info);
	int32				OnDataProtocol4Impl(FStreamReader& Reader, FThreads::FInfo& ThreadInfo);
	int32				OnDataProtocol4Known(uint32 Uid, FStreamReader& Reader, FThreads::FInfo& ThreadInfo);
	bool				AddDispatch(FDispatch* Dispatch);
	template <typename ImplType>
	void				ForEachRoute(uint32 RouteIndex, bool bScoped, ImplType&& Impl);
	void				AddRoute(uint16 AnalyzerIndex, uint16 Id, const ANSICHAR* Logger, const ANSICHAR* Event, bool bScoped);
	void				RetireAnalyzer(IAnalyzer* Analyzer);
	FThreads			Threads;
	FTiming				Timing;
	TArray<FRoute>		Routes;
	TArray<IAnalyzer*>	Analyzers;
	TArray<FDispatch*>	Dispatches;
	class FTransport*	Transport = nullptr;
	ProtocolHandlerType	ProtocolHandler = nullptr;
	struct
	{
		uint32			Value = 0;
		uint32			Mask = 0;
	}					Serial;
	uint32				UserUidBias = 1; // 1 because new-event events must exists be uid zero.
	uint8				ProtocolVersion = 0;
};

} // namespace Trace
} // namespace UE