TickTaskManager.cpp File Reference

#include "Engine/Level.h"
#include "Engine/World.h"
#include "ProfilingDebugging/CsvProfiler.h"
#include "Stats/StatsTrace.h"
#include "TickTaskManagerInterface.h"
#include "Async/ParallelFor.h"
#include "Misc/Fork.h"
#include "Misc/TimeGuard.h"
#include "Templates/UniquePtr.h"
#include "UObject/RemoteExecutor.h"
#include "TaskSyncManager.h"

Classes
class	TArrayWithThreadsafeAdd< InElementType, InAllocator >
struct	FTickContext
struct	FTickGroupCondition
class	FTickFunctionTask
struct	FTickBatchInfo
class	FBatchTickFunctionTask
class	FTickTaskSequencer
class	FTickTaskLevel
struct	FTickTaskLevel::FTickScheduleDetails
struct	FTickGroupCompletionItem
class	FTickTaskManager
struct	FTestTickFunction
struct	TStructOpsTypeTraits< FTestTickFunction >

Typedefs
using	FTickGraphTask = FBaseGraphTask

Functions
	DEFINE_LOG_CATEGORY_STATIC (LogTick, Log, All)
	DECLARE_CYCLE_STAT (TEXT("Queue Ticks"), STAT_QueueTicks, STATGROUP_Game)
	DECLARE_CYCLE_STAT (TEXT("Queue Ticks Wait"), STAT_QueueTicksWait, STATGROUP_Game)
	DECLARE_CYCLE_STAT (TEXT("Queue Tick Task"), STAT_QueueTickTask, STATGROUP_Game)
	DECLARE_CYCLE_STAT (TEXT("Post Queue Tick Task"), STAT_PostTickTask, STATGROUP_Game)
	DECLARE_CYCLE_STAT (TEXT("Finalize Parallel Queue"), STAT_FinalizeParallelQueue, STATGROUP_Game)
	DECLARE_CYCLE_STAT (TEXT("Do Deferred Removes"), STAT_DoDeferredRemoves, STATGROUP_Game)
	DECLARE_CYCLE_STAT (TEXT("Schedule cooldowns"), STAT_ScheduleCooldowns, STATGROUP_Game)
	DECLARE_DWORD_COUNTER_STAT (TEXT("Ticks Queued"), STAT_TicksQueued, STATGROUP_Game)
	DECLARE_CYCLE_STAT (TEXT("TG_NewlySpawned"), STAT_TG_NewlySpawned, STATGROUP_TickGroups)
	DECLARE_CYCLE_STAT (TEXT("ReleaseTickGroup"), STAT_ReleaseTickGroup, STATGROUP_TickGroups)
	DECLARE_CYCLE_STAT (TEXT("ReleaseTickGroup Block"), STAT_ReleaseTickGroup_Block, STATGROUP_TickGroups)
	DECLARE_CYCLE_STAT (TEXT("CleanupTasksWait"), STAT_CleanupTasksWait, STATGROUP_TickGroups)
	CSV_DECLARE_CATEGORY_MODULE_EXTERN (CORE_API, Basic)
FORCEINLINE bool	CanDemoteIntoTickGroup (ETickingGroup TickGroup)

Variables
FAutoConsoleTaskPriority	CPrio_DispatchTaskPriority (TEXT("TaskGraph.TaskPriorities.TickDispatchTaskPriority"), TEXT("Task and thread priority for tick tasks dispatch."), ENamedThreads::HighThreadPriority, ENamedThreads::NormalTaskPriority, ENamedThreads::HighTaskPriority)
FAutoConsoleTaskPriority	CPrio_CleanupTaskPriority (TEXT("TaskGraph.TaskPriorities.TickCleanupTaskPriority"), TEXT("Task and thread priority for tick cleanup."), ENamedThreads::NormalThreadPriority, ENamedThreads::NormalTaskPriority)
FAutoConsoleTaskPriority	CPrio_NormalAsyncTickTaskPriority (TEXT("TaskGraph.TaskPriorities.NormalAsyncTickTaskPriority"), TEXT("Task and thread priority for async ticks that are not high priority."), ENamedThreads::NormalThreadPriority, ENamedThreads::NormalTaskPriority)
FAutoConsoleTaskPriority	CPrio_HiPriAsyncTickTaskPriority (TEXT("TaskGraph.TaskPriorities.HiPriAsyncTickTaskPriority"), TEXT("Task and thread priority for async ticks that are high priority."), ENamedThreads::HighThreadPriority, ENamedThreads::NormalTaskPriority, ENamedThreads::HighTaskPriority)

Typedef Documentation

FTickGraphTask

using FTickGraphTask = FBaseGraphTask

Function Documentation

CanDemoteIntoTickGroup()

FORCEINLINE bool CanDemoteIntoTickGroup

(

ETickingGroup

TickGroup

)

CSV_DECLARE_CATEGORY_MODULE_EXTERN()

CSV_DECLARE_CATEGORY_MODULE_EXTERN	(	CORE_API	,
		Basic
	)

DECLARE_CYCLE_STAT() [1/11]

DECLARE_CYCLE_STAT	(	TEXT("CleanupTasksWait")	,
		STAT_CleanupTasksWait	,
		STATGROUP_TickGroups
	)

DECLARE_CYCLE_STAT() [2/11]

DECLARE_CYCLE_STAT	(	TEXT("Do Deferred Removes")	,
		STAT_DoDeferredRemoves	,
		STATGROUP_Game
	)

DECLARE_CYCLE_STAT() [3/11]

DECLARE_CYCLE_STAT	(	TEXT("Finalize Parallel Queue")	,
		STAT_FinalizeParallelQueue	,
		STATGROUP_Game
	)

DECLARE_CYCLE_STAT() [4/11]

DECLARE_CYCLE_STAT	(	TEXT("Post Queue Tick Task")	,
		STAT_PostTickTask	,
		STATGROUP_Game
	)

DECLARE_CYCLE_STAT() [5/11]

DECLARE_CYCLE_STAT	(	TEXT("Queue Tick Task")	,
		STAT_QueueTickTask	,
		STATGROUP_Game
	)

DECLARE_CYCLE_STAT() [6/11]

DECLARE_CYCLE_STAT	(	TEXT("Queue Ticks Wait")	,
		STAT_QueueTicksWait	,
		STATGROUP_Game
	)

DECLARE_CYCLE_STAT() [7/11]

DECLARE_CYCLE_STAT	(	TEXT("Queue Ticks")	,
		STAT_QueueTicks	,
		STATGROUP_Game
	)

DECLARE_CYCLE_STAT() [8/11]

DECLARE_CYCLE_STAT	(	TEXT("ReleaseTickGroup Block")	,
		STAT_ReleaseTickGroup_Block	,
		STATGROUP_TickGroups
	)

DECLARE_CYCLE_STAT() [9/11]

DECLARE_CYCLE_STAT	(	TEXT("ReleaseTickGroup")	,
		STAT_ReleaseTickGroup	,
		STATGROUP_TickGroups
	)

DECLARE_CYCLE_STAT() [10/11]

DECLARE_CYCLE_STAT	(	TEXT("Schedule cooldowns")	,
		STAT_ScheduleCooldowns	,
		STATGROUP_Game
	)

DECLARE_CYCLE_STAT() [11/11]

DECLARE_CYCLE_STAT	(	TEXT("TG_NewlySpawned")	,
		STAT_TG_NewlySpawned	,
		STATGROUP_TickGroups
	)

DECLARE_DWORD_COUNTER_STAT()

DECLARE_DWORD_COUNTER_STAT	(	TEXT("Ticks Queued")	,
		STAT_TicksQueued	,
		STATGROUP_Game
	)

DEFINE_LOG_CATEGORY_STATIC()

DEFINE_LOG_CATEGORY_STATIC	(	LogTick	,
		Log	,
		All
	)

Variable Documentation

CPrio_CleanupTaskPriority

FAutoConsoleTaskPriority CPrio_CleanupTaskPriority(TEXT("TaskGraph.TaskPriorities.TickCleanupTaskPriority"), TEXT("Task and thread priority for tick cleanup."), ENamedThreads::NormalThreadPriority, ENamedThreads::NormalTaskPriority)	(	TEXT("TaskGraph.TaskPriorities.TickCleanupTaskPriority")	,
		TEXT("Task and thread priority for tick cleanup.")	,
		ENamedThreads::NormalThreadPriority	,
		ENamedThreads::NormalTaskPriority
	)

CPrio_DispatchTaskPriority

FAutoConsoleTaskPriority CPrio_DispatchTaskPriority(TEXT("TaskGraph.TaskPriorities.TickDispatchTaskPriority"), TEXT("Task and thread priority for tick tasks dispatch."), ENamedThreads::HighThreadPriority, ENamedThreads::NormalTaskPriority, ENamedThreads::HighTaskPriority)	(	TEXT("TaskGraph.TaskPriorities.TickDispatchTaskPriority")	,
		TEXT("Task and thread priority for tick tasks dispatch.")	,
		ENamedThreads::HighThreadPriority	,
		ENamedThreads::NormalTaskPriority	,
		ENamedThreads::HighTaskPriority
	)

CPrio_HiPriAsyncTickTaskPriority

FAutoConsoleTaskPriority CPrio_HiPriAsyncTickTaskPriority(TEXT("TaskGraph.TaskPriorities.HiPriAsyncTickTaskPriority"), TEXT("Task and thread priority for async ticks that are high priority."), ENamedThreads::HighThreadPriority, ENamedThreads::NormalTaskPriority, ENamedThreads::HighTaskPriority)	(	TEXT("TaskGraph.TaskPriorities.HiPriAsyncTickTaskPriority")	,
		TEXT("Task and thread priority for async ticks that are high priority.")	,
		ENamedThreads::HighThreadPriority	,
		ENamedThreads::NormalTaskPriority	,
		ENamedThreads::HighTaskPriority
	)

CPrio_NormalAsyncTickTaskPriority

FAutoConsoleTaskPriority CPrio_NormalAsyncTickTaskPriority(TEXT("TaskGraph.TaskPriorities.NormalAsyncTickTaskPriority"), TEXT("Task and thread priority for async ticks that are not high priority."), ENamedThreads::NormalThreadPriority, ENamedThreads::NormalTaskPriority)	(	TEXT("TaskGraph.TaskPriorities.NormalAsyncTickTaskPriority")	,
		TEXT("Task and thread priority for async ticks that are not high priority.")	,
		ENamedThreads::NormalThreadPriority	,
		ENamedThreads::NormalTaskPriority
	)