You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
bfda02d384
Any function that may create a request now has a IRequestOwner& parameter, and uses the Begin and End functions on the owner to manage the lifetime of any requests that it creates, as well as using End to invoke the completion callback for any request which has one. The new FRequestBarrier may be used to block a group from being considered complete in a scope where more requests may be added to it. #rb Matt.Peters #rnx #preflight 6109b5c403d303000144cce5 #preflight 610acf7103d30300016fda94 #ROBOMERGE-SOURCE: CL 17060470 in //UE5/Main/... #ROBOMERGE-BOT: STARSHIP (Main -> Release-Engine-Test) (v850-17047176) [CL 17060649 by devin doucette in ue5-release-engine-test branch]
85 lines
3.6 KiB
C++
85 lines
3.6 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "DerivedDataBuildJob.h"
|
|
#include "DerivedDataBuildKey.h"
|
|
|
|
namespace UE::DerivedData { class IRequestOwner; }
|
|
namespace UE::DerivedData { struct FBuildSchedulerParams; }
|
|
|
|
namespace UE::DerivedData
|
|
{
|
|
|
|
/**
|
|
* A build scheduler is responsible for deciding when and where a job executes in certain states.
|
|
*
|
|
* Jobs dispatch themselves to their scheduler when they are prepared to access limited resources
|
|
* such as: memory, compute, storage, network. A scheduler may allow a job to execute immediately
|
|
* or may queue it to execute later. A scheduler that uses a job queue is expected to execute the
|
|
* jobs in priority order, respecting updates to priority.
|
|
*/
|
|
class IBuildScheduler
|
|
{
|
|
public:
|
|
virtual ~IBuildScheduler() = default;
|
|
|
|
/** Begin processing of the job by this scheduler. Always paired with EndJob. */
|
|
virtual void BeginJob(IBuildJob* Job) {}
|
|
|
|
/** End processing of the job by this scheduler. Always paired with BeginJob. */
|
|
virtual void EndJob(IBuildJob* Job) {}
|
|
|
|
/** Dispatch the job immediately if it is queued. May be called multiple times and/or concurrently. */
|
|
virtual void CancelJob(IBuildJob* Job) {}
|
|
|
|
/** Update the priority of the job if it is queued. May be called multiple times and/or concurrently. */
|
|
virtual void UpdateJobPriority(IBuildJob* Job) {}
|
|
|
|
/** Dispatch by calling Schedule or SetOutput, either now or later. */
|
|
virtual void DispatchCacheQuery(IBuildJob* Job, IRequestOwner& Owner, const FBuildSchedulerParams& Params) { Job->Schedule(); }
|
|
|
|
/** Dispatch by calling Schedule, either now or later. */
|
|
virtual void DispatchCacheStore(IBuildJob* Job, IRequestOwner& Owner, const FBuildSchedulerParams& Params) { Job->Schedule(); }
|
|
|
|
/** Dispatch by calling Schedule, either now or later. */
|
|
virtual void DispatchResolveKey(IBuildJob* Job, IRequestOwner& Owner) { Job->Schedule(); }
|
|
|
|
/** Dispatch by calling Schedule, either now or later. */
|
|
virtual void DispatchResolveInputMeta(IBuildJob* Job, IRequestOwner& Owner) { Job->Schedule(); }
|
|
|
|
/**
|
|
* Dispatch by calling Schedule, SetOutput, or SkipExecuteRemote, either now or later.
|
|
*
|
|
* SkipExecuteRemote is only valid to call when MissingRemoteInputsSize is non-zero.
|
|
*/
|
|
virtual void DispatchResolveInputData(IBuildJob* Job, IRequestOwner& Owner, const FBuildSchedulerParams& Params) { Job->Schedule(); }
|
|
|
|
/** Dispatch by calling Schedule, SetOutput, or SkipExecuteRemote, either now or later. */
|
|
virtual void DispatchExecuteRemote(IBuildJob* Job, IRequestOwner& Owner, const FBuildSchedulerParams& Params) { Job->Schedule(); }
|
|
|
|
/** Dispatch by calling Schedule or SetOutput, either now or later. */
|
|
virtual void DispatchExecuteLocal(IBuildJob* Job, IRequestOwner& Owner, const FBuildSchedulerParams& Params) { Job->Schedule(); }
|
|
|
|
/** Set the output of the job. Always called once between BeginJob and EndJob unless canceled. */
|
|
virtual void SetJobOutput(IBuildJob* Job, const FBuildSchedulerParams& Params, const FBuildOutput& Output) {}
|
|
};
|
|
|
|
/** Parameters that describe a build job to the build scheduler. */
|
|
struct FBuildSchedulerParams
|
|
{
|
|
FBuildActionKey Key;
|
|
|
|
/** Total size of constants and inputs, whether resolved or not. */
|
|
uint64 TotalInputsSize = 0;
|
|
/** Total size of constants and resolved inputs that are in memory now. */
|
|
uint64 ResolvedInputsSize = 0;
|
|
|
|
/** Total size of inputs that need to be resolved for local execution. Available in ResolveInputData. */
|
|
uint64 MissingLocalInputsSize = 0;
|
|
/** Total size of inputs that need to be resolved for remote execution. Available in ResolveInputData. */
|
|
uint64 MissingRemoteInputsSize = 0;
|
|
};
|
|
|
|
} // UE::DerivedData
|