2022-09-26 15:12:13 -04:00
// Copyright Epic Games, Inc. All Rights Reserved.
2022-10-01 02:04:57 -04:00
# include "MuCO/CustomizableObjectSystem.h"
2022-09-26 15:12:13 -04:00
2022-10-02 10:56:02 -04:00
# include "Animation/Skeleton.h"
# include "AssetRegistry/ARFilter.h"
# include "AssetRegistry/AssetRegistryModule.h"
# include "Engine/SkeletalMesh.h"
2023-01-12 01:48:34 -05:00
# include "Engine/SkinnedAsset.h"
2022-10-02 10:56:02 -04:00
# include "GameFramework/Pawn.h"
2023-01-12 01:48:34 -05:00
# include "Engine/SkinnedAssetCommon.h"
2022-10-02 10:56:02 -04:00
# include "GameFramework/PlayerController.h"
# include "Interfaces/ITargetPlatform.h"
# include "Kismet/GameplayStatics.h"
# include "MuCO/CustomizableInstanceLODManagement.h"
2022-10-01 02:04:57 -04:00
# include "MuCO/CustomizableInstancePrivateData.h"
2022-10-02 10:56:02 -04:00
# include "MuCO/CustomizableObjectPrivate.h"
2022-11-04 09:18:44 -04:00
# include "MuCO/DefaultImageProvider.h"
2022-10-02 10:56:02 -04:00
# include "MuCO/CustomizableSkeletalComponent.h"
# include "MuCO/ICustomizableObjectModule.h"
# include "MuCO/LogBenchmarkUtil.h"
# include "MuCO/LogInformationUtil.h"
# include "MuCO/UnrealBakeHelpers.h"
2023-04-05 11:20:44 -04:00
# include "MuCO/UnrealExtensionDataStreamer.h"
2022-10-01 02:06:09 -04:00
# include "MuCO/UnrealMutableImageProvider.h"
2022-10-01 02:04:57 -04:00
# include "MuCO/UnrealMutableModelDiskStreamer.h"
2023-04-04 06:06:06 -04:00
# include "MuCO/UnrealPortabilityHelpers.h"
2023-01-12 01:48:34 -05:00
# include "MuR/Model.h"
2022-10-02 10:56:02 -04:00
# include "MuR/Settings.h"
# include "TextureResource.h"
# include "UObject/UObjectIterator.h"
# include "Widgets/Notifications/SNotificationList.h"
2023-03-15 07:39:39 -04:00
# include "ContentStreaming.h"
2022-09-26 15:12:13 -04:00
# if WITH_EDITOR
# include "Editor.h"
2022-10-02 10:56:02 -04:00
# include "Logging/MessageLog.h"
2022-09-26 15:12:13 -04:00
# include "Misc/ConfigCacheIni.h"
# include "Misc/MessageDialog.h"
2023-01-12 02:59:45 -05:00
# else
# include "Engine/Engine.h"
2022-09-26 15:12:13 -04:00
# endif
2022-10-02 10:56:02 -04:00
# include UE_INLINE_GENERATED_CPP_BY_NAME(CustomizableObjectSystem)
class AActor ;
class UAnimInstance ;
class UMaterialInterface ;
2022-09-26 15:12:13 -04:00
2022-10-10 07:09:51 -04:00
namespace impl
{
void Task_Game_Callbacks_Work ( UCustomizableObjectInstance * CustomizableObjectInstance ) ;
}
2022-09-26 15:12:13 -04:00
DEFINE_STAT ( STAT_MutableNumSkeletalMeshes ) ;
DEFINE_STAT ( STAT_MutableNumCachedSkeletalMeshes ) ;
DEFINE_STAT ( STAT_MutableNumAllocatedSkeletalMeshes ) ;
DEFINE_STAT ( STAT_MutableNumInstancesLOD0 ) ;
DEFINE_STAT ( STAT_MutableNumInstancesLOD1 ) ;
DEFINE_STAT ( STAT_MutableNumInstancesLOD2 ) ;
DEFINE_STAT ( STAT_MutableSkeletalMeshResourceMemory ) ;
DEFINE_STAT ( STAT_MutableNumTextures ) ;
DEFINE_STAT ( STAT_MutableNumCachedTextures ) ;
DEFINE_STAT ( STAT_MutableNumAllocatedTextures ) ;
DEFINE_STAT ( STAT_MutableTextureResourceMemory ) ;
DEFINE_STAT ( STAT_MutableTextureGeneratedMemory ) ;
DEFINE_STAT ( STAT_MutableTextureCacheMemory ) ;
DEFINE_STAT ( STAT_MutablePendingInstanceUpdates ) ;
DEFINE_STAT ( STAT_MutableAbandonedInstanceUpdates ) ;
DEFINE_STAT ( STAT_MutableInstanceBuildTime ) ;
DEFINE_STAT ( STAT_MutableInstanceBuildTimeAvrg ) ;
DEFINE_STAT ( STAT_MutableStreamingOps ) ;
DECLARE_CYCLE_STAT ( TEXT ( " MutablePendingRelease Time " ) , STAT_MutablePendingRelease , STATGROUP_Game ) ;
DECLARE_CYCLE_STAT ( TEXT ( " MutableTask " ) , STAT_MutableTask , STATGROUP_Game ) ;
UCustomizableObjectSystem * FCustomizableObjectSystemPrivate : : SSystem = nullptr ;
2023-05-24 02:50:03 -04:00
static TAutoConsoleVariable < int32 > CVarWorkingMemory (
TEXT ( " mutable.WorkingMemory " ) ,
2023-03-14 07:59:06 -04:00
# if !PLATFORM_DESKTOP
2023-05-24 02:50:03 -04:00
( 10 * 1024 ) ,
2023-03-14 07:59:06 -04:00
# else
2023-05-24 02:50:03 -04:00
( 50 * 1024 ) ,
2023-03-14 07:59:06 -04:00
# endif
2023-05-24 02:50:03 -04:00
TEXT ( " Limit the amount of memory (in KB) to use as working memory when building characters. More memory reduces the object construction time. 0 means no restriction. Defaults: Desktop = 50,000 KB, Others = 10,000 KB " ) ,
2022-09-26 15:12:13 -04:00
ECVF_Scalability ) ;
2023-05-24 02:50:03 -04:00
TAutoConsoleVariable < bool > CVarClearWorkingMemoryOnUpdateEnd (
2023-06-01 04:30:20 -04:00
TEXT ( " mutable.ClearWorkingMemoryOnUpdateEnd " ) ,
2023-03-07 12:43:38 -05:00
false ,
2023-05-26 15:05:33 -04:00
TEXT ( " Clear the working memory and cache after every Mutable operation. " ) ,
2023-03-07 12:43:38 -05:00
ECVF_Scalability ) ;
2023-06-27 06:04:11 -04:00
TAutoConsoleVariable < bool > CVarReuseImagesBetweenInstances (
TEXT ( " mutable.ReuseImagesBetweenInstances " ) ,
2023-03-17 06:24:34 -04:00
true ,
2023-06-27 06:04:11 -04:00
TEXT ( " Enables or disables the reuse of images between instances. " ) ,
2023-03-17 06:24:34 -04:00
ECVF_Scalability ) ;
2023-06-26 02:16:47 -04:00
static TAutoConsoleVariable < int32 > CVarGeneratedResourcesCacheSize (
TEXT ( " mutable.GeneratedResourcesCacheSize " ) ,
512 ,
TEXT ( " Limit the number of resources (images and meshes) that will be tracked for reusal. Each tracked resource uses a small amout of memory for its key. " ) ,
ECVF_Scalability ) ;
2023-03-17 06:24:34 -04:00
2023-06-22 06:24:44 -04:00
bool FMutablePendingInstanceWork : : ArePendingUpdatesEmpty ( ) const
2022-09-26 15:12:13 -04:00
{
2023-06-22 06:24:44 -04:00
return PendingInstanceUpdates . Num ( ) = = 0 ;
2022-09-26 15:12:13 -04:00
}
2023-06-22 06:24:44 -04:00
int32 FMutablePendingInstanceWork : : Num ( ) const
2022-09-26 15:12:13 -04:00
{
2023-06-22 06:24:44 -04:00
return PendingInstanceUpdates . Num ( ) + PendingInstanceDiscards . Num ( ) + PendingIDsToRelease . Num ( ) + NumLODUpdatesLastTick ;
2022-09-26 15:12:13 -04:00
}
2023-06-22 06:24:44 -04:00
void FMutablePendingInstanceWork : : SetLODUpdatesLastTick ( int32 NumLODUpdates )
2022-09-26 15:12:13 -04:00
{
2023-06-22 06:24:44 -04:00
NumLODUpdatesLastTick = NumLODUpdates ;
}
void FMutablePendingInstanceWork : : AddUpdate ( const FMutablePendingInstanceUpdate & UpdateToAdd )
{
if ( FMutablePendingInstanceUpdate * ExistingUpdate = PendingInstanceUpdates . Find ( UpdateToAdd . CustomizableObjectInstance ) )
2022-09-26 15:12:13 -04:00
{
2023-06-22 06:24:44 -04:00
FMutablePendingInstanceUpdate TaskToEnqueue = UpdateToAdd ;
FInstanceUpdateDelegate * Callback = ExistingUpdate - > Callback ;
2023-07-28 06:06:02 -04:00
FinishUpdateGlobal ( ExistingUpdate - > CustomizableObjectInstance . Get ( ) , EUpdateResult : : ErrorReplaced , Callback ) ;
2023-06-22 06:24:44 -04:00
TaskToEnqueue . PriorityType = FMath : : Min ( ExistingUpdate - > PriorityType , UpdateToAdd . PriorityType ) ;
TaskToEnqueue . SecondsAtUpdate = FMath : : Min ( ExistingUpdate - > SecondsAtUpdate , UpdateToAdd . SecondsAtUpdate ) ;
2023-04-06 16:56:51 -04:00
2023-06-22 06:24:44 -04:00
PendingInstanceUpdates . Remove ( ExistingUpdate - > CustomizableObjectInstance ) ;
PendingInstanceUpdates . Add ( TaskToEnqueue ) ;
2022-09-26 15:12:13 -04:00
}
2023-06-22 06:24:44 -04:00
else
2022-09-26 15:12:13 -04:00
{
2023-06-22 06:24:44 -04:00
PendingInstanceUpdates . Add ( UpdateToAdd ) ;
2022-09-26 15:12:13 -04:00
}
2023-06-22 06:24:44 -04:00
if ( FMutablePendingInstanceDiscard * ExistingDiscard = PendingInstanceDiscards . Find ( UpdateToAdd . CustomizableObjectInstance ) )
2022-09-26 15:12:13 -04:00
{
2023-07-28 06:06:02 -04:00
FinishUpdateGlobal ( ExistingDiscard - > CustomizableObjectInstance . Get ( ) , EUpdateResult : : ErrorReplaced , nullptr ) ;
2023-06-22 06:24:44 -04:00
PendingInstanceDiscards . Remove ( ExistingDiscard - > CustomizableObjectInstance ) ;
2022-09-26 15:12:13 -04:00
}
}
2023-06-22 06:24:44 -04:00
void FMutablePendingInstanceWork : : RemoveUpdate ( const TWeakObjectPtr < UCustomizableObjectInstance > & Instance )
2022-09-26 15:12:13 -04:00
{
2023-06-22 06:24:44 -04:00
PendingInstanceUpdates . Remove ( Instance ) ;
}
const FMutablePendingInstanceUpdate * FMutablePendingInstanceWork : : GetUpdate ( const TWeakObjectPtr < UCustomizableObjectInstance > & Instance ) const
{
return PendingInstanceUpdates . Find ( Instance ) ;
}
void FMutablePendingInstanceWork : : AddDiscard ( const FMutablePendingInstanceDiscard & TaskToEnqueue )
{
if ( FMutablePendingInstanceUpdate * ExistingUpdate = PendingInstanceUpdates . Find ( TaskToEnqueue . CustomizableObjectInstance . Get ( ) ) )
2022-09-26 15:12:13 -04:00
{
2023-07-28 06:06:02 -04:00
FinishUpdateGlobal ( ExistingUpdate - > CustomizableObjectInstance . Get ( ) , EUpdateResult : : ErrorReplaced , ExistingUpdate - > Callback ) ;
2023-06-22 06:24:44 -04:00
PendingInstanceUpdates . Remove ( ExistingUpdate - > CustomizableObjectInstance ) ;
2022-09-26 15:12:13 -04:00
}
2023-06-22 06:24:44 -04:00
PendingInstanceDiscards . Add ( TaskToEnqueue ) ;
TaskToEnqueue . CustomizableObjectInstance - > GetPrivate ( ) - > SetCOInstanceFlags ( Updating ) ;
2022-09-26 15:12:13 -04:00
}
2023-06-22 06:24:44 -04:00
void FMutablePendingInstanceWork : : AddIDRelease ( mu : : Instance : : ID IDToRelease )
2022-09-26 15:12:13 -04:00
{
2023-06-22 06:24:44 -04:00
PendingIDsToRelease . Add ( IDToRelease ) ;
}
void FMutablePendingInstanceWork : : RemoveAllUpdatesAndDiscardsAndReleases ( )
{
PendingInstanceUpdates . Empty ( ) ;
PendingInstanceDiscards . Empty ( ) ;
PendingIDsToRelease . Empty ( ) ;
2022-09-26 15:12:13 -04:00
}
UCustomizableObjectSystem * UCustomizableObjectSystem : : GetInstance ( )
{
if ( ! FCustomizableObjectSystemPrivate : : SSystem )
{
2023-04-27 05:10:23 -04:00
UE_LOG ( LogMutable , Log , TEXT ( " Creating Mutable Customizable Object System. " ) ) ;
2022-09-26 15:12:13 -04:00
check ( IsInGameThread ( ) ) ;
FCustomizableObjectSystemPrivate : : SSystem = NewObject < UCustomizableObjectSystem > ( UCustomizableObjectSystem : : StaticClass ( ) ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( FCustomizableObjectSystemPrivate : : SSystem ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
checkf ( ! GUObjectArray . IsDisregardForGC ( FCustomizableObjectSystemPrivate : : SSystem ) , TEXT ( " Mutable was initialized too early in the UE4 init process, for instance, in the constructor of a default UObject. " ) ) ;
FCustomizableObjectSystemPrivate : : SSystem - > AddToRoot ( ) ;
checkf ( ! GUObjectArray . IsDisregardForGC ( FCustomizableObjectSystemPrivate : : SSystem ) , TEXT ( " Mutable was initialized too early in the UE4 init process, for instance, in the constructor of a default UObject. " ) ) ;
FCustomizableObjectSystemPrivate : : SSystem - > InitSystem ( ) ;
//FCoreUObjectDelegates::PurgePendingReleaseSkeletalMesh.AddUObject(FCustomizableObjectSystemPrivate::SSystem, &UCustomizableObjectSystem::PurgePendingReleaseSkeletalMesh);
}
return FCustomizableObjectSystemPrivate : : SSystem ;
}
FString UCustomizableObjectSystem : : GetPluginVersion ( ) const
{
// Bridge the call from the module. This implementation is available from blueprint.
return ICustomizableObjectModule : : Get ( ) . GetPluginVersion ( ) ;
}
void UCustomizableObjectSystem : : LogShowData ( bool bFullInfo , bool ShowMaterialInfo ) const
{
LogInformationUtil : : ResetCounters ( ) ;
AActor * ParentActor ;
TArray < UCustomizableObjectInstance * > ArrayData ;
for ( TObjectIterator < UCustomizableSkeletalComponent > It ; It ; + + It )
{
UCustomizableSkeletalComponent * CustomizableSkeletalComponent = * It ;
if ( ( CustomizableSkeletalComponent ! = nullptr ) & & ( CustomizableSkeletalComponent - > CustomizableObjectInstance ! = nullptr ) )
{
ParentActor = CustomizableSkeletalComponent - > GetAttachmentRootActor ( ) ;
if ( ParentActor ! = nullptr )
{
ArrayData . AddUnique ( CustomizableSkeletalComponent - > CustomizableObjectInstance ) ;
}
}
}
ArrayData . Sort ( [ ] ( UCustomizableObjectInstance & A , UCustomizableObjectInstance & B )
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( A . GetPrivate ( ) ! = nullptr ) ;
check ( B . GetPrivate ( ) ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
return ( A . GetPrivate ( ) - > LastMinSquareDistFromComponentToPlayer < B . GetPrivate ( ) - > LastMinSquareDistFromComponentToPlayer ) ;
} ) ;
int i ;
const int Max = ArrayData . Num ( ) ;
if ( bFullInfo )
{
for ( i = 0 ; i < Max ; + + i )
{
LogInformationUtil : : LogShowInstanceDataFull ( ArrayData [ i ] , ShowMaterialInfo ) ;
}
}
else
{
FString LogData = " \n \n " ;
for ( i = 0 ; i < Max ; + + i )
{
LogInformationUtil : : LogShowInstanceData ( ArrayData [ i ] , LogData ) ;
}
2023-04-27 05:10:23 -04:00
UE_LOG ( LogMutable , Log , TEXT ( " %s " ) , * LogData ) ;
2022-09-26 15:12:13 -04:00
UWorld * World = GWorld ;
if ( World )
{
APlayerController * PlayerController = World - > GetFirstPlayerController ( ) ;
if ( PlayerController )
{
PlayerController - > ClientMessage ( LogData ) ;
}
}
}
}
2023-05-24 10:22:36 -04:00
FCustomizableObjectSystemPrivate * UCustomizableObjectSystem : : GetPrivate ( )
{
return Private . Get ( ) ;
}
const FCustomizableObjectSystemPrivate * UCustomizableObjectSystem : : GetPrivate ( ) const
{
return Private . Get ( ) ;
}
FCustomizableObjectSystemPrivate * UCustomizableObjectSystem : : GetPrivateChecked ( )
{
check ( Private )
return Private . Get ( ) ;
}
const FCustomizableObjectSystemPrivate * UCustomizableObjectSystem : : GetPrivateChecked ( ) const
{
check ( Private )
return Private . Get ( ) ;
}
2022-09-26 15:12:13 -04:00
bool UCustomizableObjectSystem : : IsCreated ( )
{
return FCustomizableObjectSystemPrivate : : SSystem ! = 0 ;
}
void UCustomizableObjectSystem : : InitSystem ( )
{
// Everything initialized in Init() instead of constructor to prevent the default UCustomizableObjectSystem from registering a tick function
Private = MakeShareable ( new FCustomizableObjectSystemPrivate ( ) ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
Private - > NewCompilerFunc = nullptr ;
Private - > bReplaceDiscardedWithReferenceMesh = false ;
const IConsoleVariable * CVarSupport16BitBoneIndex = IConsoleManager : : Get ( ) . FindConsoleVariable ( TEXT ( " r.GPUSkin.Support16BitBoneIndex " ) ) ;
Private - > bSupport16BitBoneIndex = CVarSupport16BitBoneIndex ? CVarSupport16BitBoneIndex - > GetBool ( ) : false ;
Private - > CurrentMutableOperation = nullptr ;
Private - > CurrentInstanceBeingUpdated = nullptr ;
# if !UE_SERVER
Private - > TickDelegate = FTickerDelegate : : CreateUObject ( this , & UCustomizableObjectSystem : : Tick ) ;
Private - > TickDelegateHandle = FTSTicker : : GetCoreTicker ( ) . AddTicker ( Private - > TickDelegate , 0.f ) ;
# endif // !UE_SERVER
Private - > TotalBuildMs = 0 ;
Private - > TotalBuiltInstances = 0 ;
Private - > NumInstances = 0 ;
Private - > TextureMemoryUsed = 0 ;
# if !(UE_BUILD_SHIPPING || UE_BUILD_TEST)
SET_DWORD_STAT ( STAT_MutableNumSkeletalMeshes , 0 ) ;
SET_DWORD_STAT ( STAT_MutableNumTextures , 0 ) ;
SET_DWORD_STAT ( STAT_MutableInstanceBuildTime , 0 ) ;
SET_DWORD_STAT ( STAT_MutableInstanceBuildTimeAvrg , 0 ) ;
# endif
2023-05-24 02:50:03 -04:00
Private - > LastWorkingMemoryBytes = CVarWorkingMemory . GetValueOnGameThread ( ) * 1024 ;
2023-06-26 02:16:47 -04:00
Private - > LastGeneratedResourceCacheSize = CVarGeneratedResourcesCacheSize . GetValueOnGameThread ( ) ;
2023-03-14 07:59:06 -04:00
2023-05-24 02:50:03 -04:00
mu : : Ptr < mu : : Settings > pSettings = new mu : : Settings ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( pSettings ) ;
2022-09-26 15:12:13 -04:00
pSettings - > SetProfile ( false ) ;
2023-05-24 02:50:03 -04:00
pSettings - > SetWorkingMemoryBytes ( Private - > LastWorkingMemoryBytes ) ;
Private - > ExtensionDataStreamer = MakeShared < FUnrealExtensionDataStreamer > ( Private . ToSharedRef ( ) ) ;
2023-04-05 11:20:44 -04:00
Private - > MutableSystem = new mu : : System ( pSettings , Private - > ExtensionDataStreamer ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private - > MutableSystem ) ;
2022-09-26 15:12:13 -04:00
2023-06-26 02:16:47 -04:00
Private - > Streamer = MakeShared < FUnrealMutableModelBulkReader > ( ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private - > Streamer ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
Private - > MutableSystem - > SetStreamingInterface ( Private - > Streamer ) ;
// Set up the external image provider, for image parameters.
2023-05-24 02:50:03 -04:00
TSharedPtr < FUnrealMutableImageProvider > Provider = MakeShared < FUnrealMutableImageProvider > ( ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Provider ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
Private - > ImageProvider = Provider ;
Private - > MutableSystem - > SetImageParameterGenerator ( Provider ) ;
# if WITH_EDITOR
if ( ! IsRunningGame ( ) )
{
FEditorDelegates : : PreBeginPIE . AddUObject ( this , & UCustomizableObjectSystem : : OnPreBeginPIE ) ;
}
# endif
DefaultInstanceLODManagement = NewObject < UCustomizableInstanceLODManagement > ( ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( DefaultInstanceLODManagement ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
CurrentInstanceLODManagement = DefaultInstanceLODManagement ;
}
void UCustomizableObjectSystem : : BeginDestroy ( )
{
# if WITH_EDITOR
if ( RecompileCustomizableObjectsCompiler )
{
RecompileCustomizableObjectsCompiler - > ForceFinishCompilation ( ) ;
delete RecompileCustomizableObjectsCompiler ;
}
if ( ! IsRunningGame ( ) )
{
FEditorDelegates : : PreBeginPIE . RemoveAll ( this ) ;
}
# endif
// It could be null, for the default object.
if ( Private . IsValid ( ) )
{
# if !UE_SERVER
FTSTicker : : GetCoreTicker ( ) . RemoveTicker ( Private - > TickDelegateHandle ) ;
# endif // !UE_SERVER
// Discard pending game thread tasks
Private - > PendingTasks . Empty ( ) ;
// Complete pending taskgraph tasks
2023-05-15 05:50:59 -04:00
Private - > MutableTaskGraph . WaitForMutableTasks ( ) ;
2022-09-26 15:12:13 -04:00
// Clear the ongoing operation
Private - > CurrentMutableOperation = nullptr ;
// Deallocate streaming
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private - > Streamer ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
Private - > Streamer - > EndStreaming ( ) ;
Private - > CurrentInstanceBeingUpdated = nullptr ;
2023-06-22 06:24:44 -04:00
Private - > MutablePendingInstanceWork . RemoveAllUpdatesAndDiscardsAndReleases ( ) ;
2022-09-26 15:12:13 -04:00
FCustomizableObjectSystemPrivate : : SSystem = nullptr ;
Private = nullptr ;
}
Super : : BeginDestroy ( ) ;
}
FString UCustomizableObjectSystem : : GetDesc ( )
{
return TEXT ( " Customizable Object System Singleton " ) ;
}
FCustomizableObjectCompilerBase * ( * FCustomizableObjectSystemPrivate : : NewCompilerFunc ) ( ) = nullptr ;
FCustomizableObjectCompilerBase * UCustomizableObjectSystem : : GetNewCompiler ( )
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private ! = nullptr ) ;
if ( Private - > NewCompilerFunc ! = nullptr )
2022-09-26 15:12:13 -04:00
{
return Private - > NewCompilerFunc ( ) ;
}
else
{
return nullptr ;
}
}
void UCustomizableObjectSystem : : SetNewCompilerFunc ( FCustomizableObjectCompilerBase * ( * InNewCompilerFunc ) ( ) )
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
Private - > NewCompilerFunc = InNewCompilerFunc ;
}
void FCustomizableObjectSystemPrivate : : CreatedTexture ( UTexture2D * Texture )
{
// TODO: Do not keep this array unless we are gathering stats!
TextureTrackerArray . Add ( Texture ) ;
INC_DWORD_STAT ( STAT_MutableNumTextures ) ;
}
2022-11-22 04:57:22 -05:00
int32 FCustomizableObjectSystemPrivate : : EnableMutableAnimInfoDebugging = 0 ;
2022-09-26 15:12:13 -04:00
static FAutoConsoleVariableRef CVarEnableMutableAnimInfoDebugging (
2022-11-22 04:57:22 -05:00
TEXT ( " mutable.EnableMutableAnimInfoDebugging " ) , FCustomizableObjectSystemPrivate : : EnableMutableAnimInfoDebugging ,
TEXT ( " If set to 1 or greater print on screen the animation info of the pawn's Customizable Object Instance. Anim BPs, slots and tags will be displayed. "
" If the root Customizable Object is recompiled after this command is run, the used skeletal meshes will also be displayed. " ) ,
2022-09-26 15:12:13 -04:00
ECVF_Default ) ;
void FCustomizableObjectSystemPrivate : : UpdateStats ( )
{
# if !(UE_BUILD_SHIPPING || UE_BUILD_TEST)
bool bLogEnabled = true ;
# else
bool bLogEnabled = LogBenchmarkUtil : : isLoggingActive ( ) ;
# endif
if ( bLogEnabled )
{
CountAllocatedSkeletalMesh = 0 ;
int CountLOD0 = 0 ;
int CountLOD1 = 0 ;
int CountLOD2 = 0 ;
int CountTotal = 0 ;
2023-06-22 06:24:44 -04:00
2022-09-26 15:12:13 -04:00
for ( TObjectIterator < UCustomizableObjectInstance > CustomizableObjectInstance ; CustomizableObjectInstance ; + + CustomizableObjectInstance )
{
if ( IsValidChecked ( * CustomizableObjectInstance ) & & CustomizableObjectInstance - > GetPrivate ( ) )
{
+ + CountTotal ;
for ( int32 ComponentIndex = 0 ; ComponentIndex < CustomizableObjectInstance - > SkeletalMeshes . Num ( ) ; + + ComponentIndex )
{
if ( CustomizableObjectInstance - > SkeletalMeshes [ ComponentIndex ] & & CustomizableObjectInstance - > SkeletalMeshes [ ComponentIndex ] - > GetResourceForRendering ( ) )
{
CountAllocatedSkeletalMesh + + ;
2022-11-28 07:21:35 -05:00
if ( CustomizableObjectInstance - > GetCurrentMinLOD ( ) < 1 )
2022-09-26 15:12:13 -04:00
{
+ + CountLOD0 ;
}
2022-11-28 07:21:35 -05:00
else if ( CustomizableObjectInstance - > GetCurrentMaxLOD ( ) < 2 )
2022-09-26 15:12:13 -04:00
{
+ + CountLOD1 ;
}
else
{
+ + CountLOD2 ;
}
}
}
}
}
NumInstances = CountLOD0 + CountLOD1 + CountLOD2 ;
TotalInstances = CountTotal ;
2023-06-22 06:24:44 -04:00
NumPendingInstances = MutablePendingInstanceWork . Num ( ) ;
2022-09-26 15:12:13 -04:00
//SET_DWORD_STAT(STAT_MutableSkeletalMeshResourceMemory, Size / 1024.f);
2023-06-22 06:24:44 -04:00
SET_DWORD_STAT ( STAT_MutablePendingInstanceUpdates , MutablePendingInstanceWork . Num ( ) ) ;
2022-09-26 15:12:13 -04:00
uint64 Size = 0 ;
uint32 CountAllocated = 0 ;
for ( TWeakObjectPtr < UTexture2D > & Tracker : TextureTrackerArray )
{
if ( Tracker . IsValid ( ) & & Tracker - > GetResource ( ) )
{
CountAllocated + + ;
if ( Tracker - > GetResource ( ) - > TextureRHI )
{
Size + = Tracker - > CalcTextureMemorySizeEnum ( TMC_AllMips ) ;
}
}
}
TextureMemoryUsed = int64_t ( Size / 1024 ) ;
uint64 SizeGenerated = 0 ;
for ( TObjectIterator < UCustomizableObjectInstance > CustomizableObjectInstance ; CustomizableObjectInstance ; + + CustomizableObjectInstance )
{
if ( IsValidChecked ( * CustomizableObjectInstance ) & & CustomizableObjectInstance - > GetPrivate ( ) & & CustomizableObjectInstance - > HasAnySkeletalMesh ( ) )
{
bool bHasResourceForRendering = false ;
for ( int32 MeshIndex = 0 ; ! bHasResourceForRendering & & MeshIndex < CustomizableObjectInstance - > SkeletalMeshes . Num ( ) ; + + MeshIndex )
{
bHasResourceForRendering = CustomizableObjectInstance - > GetSkeletalMesh ( MeshIndex ) & & CustomizableObjectInstance - > GetSkeletalMesh ( MeshIndex ) - > GetResourceForRendering ( ) ;
}
if ( bHasResourceForRendering )
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
for ( const FGeneratedTexture & GeneratedTextures : CustomizableObjectInstance - > GetPrivate ( ) - > GeneratedTextures )
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
if ( GeneratedTextures . Texture )
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( GeneratedTextures . Texture ! = nullptr ) ;
SizeGenerated + = GeneratedTextures . Texture - > CalcTextureMemorySizeEnum ( TMC_AllMips ) ;
2022-09-26 15:12:13 -04:00
}
}
}
}
}
if ( LogBenchmarkUtil : : isLoggingActive ( ) )
{
LogBenchmarkUtil : : updateStat ( " customizable_objects " , ( int32 ) CountAllocatedSkeletalMesh ) ;
2023-06-22 06:24:44 -04:00
LogBenchmarkUtil : : updateStat ( " pending_instance_updates " , MutablePendingInstanceWork . Num ( ) ) ;
2022-09-26 15:12:13 -04:00
LogBenchmarkUtil : : updateStat ( " allocated_textures " , ( int32 ) CountAllocated ) ;
LogBenchmarkUtil : : updateStat ( " texture_resource_memory " , ( long double ) Size / 1048576.0 L ) ;
LogBenchmarkUtil : : updateStat ( " texture_generated_memory " , ( long double ) SizeGenerated / 1048576.0 L ) ;
}
# if !(UE_BUILD_SHIPPING || UE_BUILD_TEST)
SET_DWORD_STAT ( STAT_MutableNumInstancesLOD0 , CountLOD0 ) ;
SET_DWORD_STAT ( STAT_MutableNumInstancesLOD1 , CountLOD1 ) ;
SET_DWORD_STAT ( STAT_MutableNumInstancesLOD2 , CountLOD2 ) ;
SET_DWORD_STAT ( STAT_MutableNumAllocatedSkeletalMeshes , CountAllocatedSkeletalMesh ) ;
2023-06-22 06:24:44 -04:00
SET_DWORD_STAT ( STAT_MutablePendingInstanceUpdates , MutablePendingInstanceWork . Num ( ) ) ;
2022-09-26 15:12:13 -04:00
SET_DWORD_STAT ( STAT_MutableNumAllocatedTextures , CountAllocated ) ;
SET_DWORD_STAT ( STAT_MutableTextureResourceMemory , Size / 1024.f ) ;
SET_DWORD_STAT ( STAT_MutableTextureGeneratedMemory , SizeGenerated / 1024.f ) ;
# endif
2022-11-22 04:57:22 -05:00
# if WITH_EDITORONLY_DATA
if ( FCustomizableObjectSystemPrivate : : IsMutableAnimInfoDebuggingEnabled ( ) )
2022-09-26 15:12:13 -04:00
{
if ( GEngine )
{
bool bFoundPlayer = false ;
int32 MsgIndex = 15820 ; // Arbitrary big value to prevent collisions with other on-screen messages
for ( TObjectIterator < UCustomizableSkeletalComponent > CustomizableSkeletalComponent ; CustomizableSkeletalComponent ; + + CustomizableSkeletalComponent )
{
AActor * ParentActor = CustomizableSkeletalComponent - > GetAttachmentRootActor ( ) ;
UCustomizableObjectInstance * Instance = CustomizableSkeletalComponent - > CustomizableObjectInstance ;
2023-03-06 10:30:12 -05:00
APawn * PlayerPawn = nullptr ;
if ( UWorld * World = CustomizableSkeletalComponent - > GetWorld ( ) )
{
PlayerPawn = UGameplayStatics : : GetPlayerPawn ( World , 0 ) ;
}
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
if ( ParentActor & & ( ParentActor = = PlayerPawn ) & & Instance )
2022-09-26 15:12:13 -04:00
{
bFoundPlayer = true ;
FString TagString ;
const FGameplayTagContainer & Tags = Instance - > GetAnimationGameplayTags ( ) ;
for ( const FGameplayTag & Tag : Tags )
{
TagString + = ! TagString . IsEmpty ( ) ? FString ( TEXT ( " , " ) ) : FString ( ) ;
TagString + = Tag . ToString ( ) ;
}
GEngine - > AddOnScreenDebugMessage ( MsgIndex + + , .0f , FColor : : Green , TEXT ( " Animation tags: " ) + TagString ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Instance - > GetPrivate ( ) ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
FCustomizableInstanceComponentData * ComponentData = Instance - > GetPrivate ( ) - > GetComponentData ( CustomizableSkeletalComponent - > ComponentIndex ) ;
if ( ComponentData )
{
2023-04-24 22:59:10 -04:00
for ( TPair < FName , TSoftClassPtr < UAnimInstance > > & Entry : ComponentData - > AnimSlotToBP )
2022-09-26 15:12:13 -04:00
{
FString AnimBPSlot ;
2023-04-24 22:59:10 -04:00
AnimBPSlot + = Entry . Key . ToString ( ) + FString ( " - " ) + Entry . Value . GetAssetName ( ) ;
2022-09-26 15:12:13 -04:00
GEngine - > AddOnScreenDebugMessage ( MsgIndex + + , .0f , FColor : : Green , AnimBPSlot ) ;
}
}
GEngine - > AddOnScreenDebugMessage ( MsgIndex + + , .0f , FColor : : Green , TEXT ( " Slots-AnimBP: " ) ) ;
2022-11-22 04:57:22 -05:00
if ( ComponentData )
{
if ( ComponentData - > MeshPartPaths . IsEmpty ( ) )
{
GEngine - > AddOnScreenDebugMessage ( MsgIndex + + , .0f , FColor : : Magenta ,
TEXT ( " No meshes found. In order to see the meshes compile the pawn's root CustomizableObject after the 'mutable.EnableMutableAnimInfoDebugging 1' command has been run. " ) ) ;
}
for ( const FString & MeshPath : ComponentData - > MeshPartPaths )
{
GEngine - > AddOnScreenDebugMessage ( MsgIndex + + , .0f , FColor : : Magenta , MeshPath ) ;
}
}
GEngine - > AddOnScreenDebugMessage ( MsgIndex + + , .0f , FColor : : Magenta , TEXT ( " Meshes: " ) ) ;
GEngine - > AddOnScreenDebugMessage ( MsgIndex + + , .0f , FColor : : Cyan ,
TEXT ( " Player Pawn Mutable Mesh/Animation info for component " ) + FString : : Printf ( TEXT ( " %d " ) ,
CustomizableSkeletalComponent - > ComponentIndex ) ) ;
2022-09-26 15:12:13 -04:00
}
}
if ( ! bFoundPlayer )
{
GEngine - > AddOnScreenDebugMessage ( MsgIndex , .0f , FColor : : Yellow , TEXT ( " Mutable Animation info: N/A " ) ) ;
}
}
}
2022-11-22 04:57:22 -05:00
# endif
2022-09-26 15:12:13 -04:00
}
}
void FCustomizableObjectSystemPrivate : : AddReferencedObjects ( FReferenceCollector & Collector )
{
if ( CurrentInstanceBeingUpdated )
{
Collector . AddReferencedObject ( CurrentInstanceBeingUpdated ) ;
}
}
2022-11-11 14:11:45 -05:00
int32 FCustomizableObjectSystemPrivate : : EnableMutableProgressiveMipStreaming = 1 ;
2022-09-26 15:12:13 -04:00
// Warning! If this is enabled, do not get references to the textures generated by Mutable! They are owned by Mutable and could become invalid at any moment
static FAutoConsoleVariableRef CVarEnableMutableProgressiveMipStreaming (
TEXT ( " mutable.EnableMutableProgressiveMipStreaming " ) , FCustomizableObjectSystemPrivate : : EnableMutableProgressiveMipStreaming ,
TEXT ( " If set to 1 or greater use progressive Mutable Mip streaming for Mutable textures. If disabled, all mips will always be generated and spending memory. In that case, on Desktop platforms they will be stored in CPU memory, on other platforms textures will be non-streaming. " ) ,
ECVF_Default ) ;
2023-01-11 14:44:41 -05:00
int32 FCustomizableObjectSystemPrivate : : EnableMutableLiveUpdate = 1 ;
static FAutoConsoleVariableRef CVarEnableMutableLiveUpdate (
TEXT ( " mutable.EnableMutableLiveUpdate " ) , FCustomizableObjectSystemPrivate : : EnableMutableLiveUpdate ,
TEXT ( " If set to 1 or greater Mutable can use the live update mode if set in the current Mutable state. If disabled, it will never use live update mode even if set in the current Mutable state. " ) ,
ECVF_Default ) ;
2023-02-02 08:45:44 -05:00
int32 FCustomizableObjectSystemPrivate : : EnableReuseInstanceTextures = 1 ;
2023-01-19 10:44:15 -05:00
static FAutoConsoleVariableRef CVarEnableMutableReuseInstanceTextures (
TEXT ( " mutable.EnableReuseInstanceTextures " ) , FCustomizableObjectSystemPrivate : : EnableReuseInstanceTextures ,
TEXT ( " If set to 1 or greater and set in the corresponding setting in the current Mutable state, Mutable can reuse instance UTextures (only uncompressed and not streaming, so set the options in the state) and their resources between updates when they are modified. If geometry or state is changed they cannot be reused. " ) ,
ECVF_Default ) ;
2023-01-24 08:45:18 -05:00
bool FCustomizableObjectSystemPrivate : : bEnableMutableReusePreviousUpdateData = false ;
static FAutoConsoleVariableRef CVarEnableMutableReusePreviousUpdateData (
TEXT ( " mutable.EnableMutableReusePreviousUpdateData " ) , FCustomizableObjectSystemPrivate : : bEnableMutableReusePreviousUpdateData ,
TEXT ( " If true, Mutable will try to reuse render sections from previous SkeletalMeshes. If false, all SkeletalMeshes will be build from scratch. " ) ,
ECVF_Default ) ;
2023-01-27 14:45:45 -05:00
int32 FCustomizableObjectSystemPrivate : : EnableOnlyGenerateRequestedLODs = 1 ;
2023-01-24 08:45:18 -05:00
static FAutoConsoleVariableRef CVarEnableOnlyGenerateRequestedLODs (
2023-01-27 14:45:45 -05:00
TEXT ( " mutable.EnableOnlyGenerateRequestedLODs " ) , FCustomizableObjectSystemPrivate : : EnableOnlyGenerateRequestedLODs ,
TEXT ( " If 1 or greater, Only the RequestedLODLevels will be generated. If 0, all LODs will be build. " ) ,
2023-01-24 08:45:18 -05:00
ECVF_Default ) ;
2023-02-02 02:41:54 -05:00
int32 FCustomizableObjectSystemPrivate : : EnableSkipGenerateResidentMips = 1 ;
static FAutoConsoleVariableRef CVarSkipGenerateResidentMips (
TEXT ( " mutable.EnableSkipGenerateResidentMips " ) , FCustomizableObjectSystemPrivate : : EnableSkipGenerateResidentMips ,
TEXT ( " If 1 or greater, resident mip generation will be optional. If 0, resident mips will be always generated " ) ,
ECVF_Default ) ;
2023-03-01 12:33:52 -05:00
int32 FCustomizableObjectSystemPrivate : : MaxTextureSizeToGenerate = 0 ;
FAutoConsoleVariableRef CVarMaxTextureSizeToGenerate (
TEXT ( " Mutable.MaxTextureSizeToGenerate " ) ,
FCustomizableObjectSystemPrivate : : MaxTextureSizeToGenerate ,
TEXT ( " Max texture size on Mutable textures. Mip 0 will be the first mip with max size equal or less than MaxTextureSizeToGenerate. "
" If a texture doesn't have small enough mips, mip 0 will be the last mip available. " ) ) ;
2023-01-24 08:45:18 -05:00
2023-07-28 06:06:02 -04:00
void FinishUpdateGlobal ( UCustomizableObjectInstance * Instance , EUpdateResult UpdateResult , FInstanceUpdateDelegate * UpdateCallback , const FDescriptorRuntimeHash InUpdatedHash )
2022-10-10 07:09:51 -04:00
{
2023-05-15 05:50:59 -04:00
check ( IsInGameThread ( ) )
2023-04-06 16:56:51 -04:00
// Callbacks. Must be done at the end.
if ( Instance )
2022-10-10 07:09:51 -04:00
{
2023-04-06 16:56:51 -04:00
Instance - > FinishUpdate ( UpdateResult , InUpdatedHash ) ;
}
2022-10-10 07:09:51 -04:00
2023-04-06 16:56:51 -04:00
if ( UpdateResult = = EUpdateResult : : Success )
{
// Call Customizable Skeletal Components updated callbacks.
for ( TObjectIterator < UCustomizableSkeletalComponent > It ; It ; + + It ) // Since iterating objects is expensive, for now CustomizableSkeletalComponent does not have a FinishUpdate function.
2022-10-10 07:09:51 -04:00
{
2023-04-06 16:56:51 -04:00
if ( const UCustomizableSkeletalComponent * CustomizableSkeletalComponent = * It ;
CustomizableSkeletalComponent & &
CustomizableSkeletalComponent - > CustomizableObjectInstance = = Instance )
2022-10-10 07:09:51 -04:00
{
2023-04-06 16:56:51 -04:00
CustomizableSkeletalComponent - > Callbacks ( ) ;
2022-10-10 07:09:51 -04:00
}
}
2023-04-06 16:56:51 -04:00
}
2022-10-10 07:09:51 -04:00
2023-04-06 16:56:51 -04:00
if ( UpdateCallback )
{
FUpdateContext Context ;
Context . UpdateResult = UpdateResult ;
UpdateCallback - > ExecuteIfBound ( Context ) ;
2022-10-10 07:09:51 -04:00
}
2023-05-15 05:50:59 -04:00
UCustomizableObjectSystem : : GetInstance ( ) - > GetPrivate ( ) - > MutableTaskGraph . AllowLaunchingMutableTaskLowPriority ( true , false ) ;
2022-10-10 07:09:51 -04:00
}
2023-04-06 16:56:51 -04:00
/** Update the given Instance Skeletal Meshes and call its callbacks. */
2023-07-28 06:06:02 -04:00
void UpdateSkeletalMesh ( UCustomizableObjectInstance & CustomizableObjectInstance , const FDescriptorRuntimeHash & UpdatedDescriptorRuntimeHash , EUpdateResult UpdateResult , FInstanceUpdateDelegate * UpdateCallback )
2023-04-06 16:56:51 -04:00
{
MUTABLE_CPUPROFILER_SCOPE ( UpdateSkeletalMesh ) ;
2023-07-18 09:36:44 -04:00
check ( IsInGameThread ( ) ) ;
2023-04-06 16:56:51 -04:00
for ( int32 ComponentIndex = 0 ; ComponentIndex < CustomizableObjectInstance . SkeletalMeshes . Num ( ) ; + + ComponentIndex )
{
if ( TObjectPtr < USkeletalMesh > SkeletalMesh = CustomizableObjectInstance . SkeletalMeshes [ ComponentIndex ] )
{
# if WITH_EDITOR
FUnrealBakeHelpers : : BakeHelper_RegenerateImportedModel ( SkeletalMesh ) ;
# else
SkeletalMesh - > RebuildSocketMap ( ) ;
# endif
}
}
UCustomizableInstancePrivateData * CustomizableObjectInstancePrivateData = CustomizableObjectInstance . GetPrivate ( ) ;
check ( CustomizableObjectInstancePrivateData ! = nullptr ) ;
for ( TObjectIterator < UCustomizableSkeletalComponent > It ; It ; + + It )
{
UCustomizableSkeletalComponent * CustomizableSkeletalComponent = * It ;
if ( CustomizableSkeletalComponent & &
( CustomizableSkeletalComponent - > CustomizableObjectInstance = = & CustomizableObjectInstance ) & &
CustomizableObjectInstance . SkeletalMeshes . IsValidIndex ( CustomizableSkeletalComponent - > ComponentIndex )
)
{
MUTABLE_CPUPROFILER_SCOPE ( UpdateSkeletalMesh_SetSkeletalMesh ) ;
const bool bIsCreatingSkeletalMesh = CustomizableObjectInstancePrivateData - > HasCOInstanceFlags ( CreatingSkeletalMesh ) ; //TODO MTBL-391: Review
CustomizableSkeletalComponent - > SetSkeletalMesh ( CustomizableObjectInstance . SkeletalMeshes [ CustomizableSkeletalComponent - > ComponentIndex ] , false , bIsCreatingSkeletalMesh ) ;
if ( CustomizableObjectInstancePrivateData - > HasCOInstanceFlags ( ReplacePhysicsAssets ) )
{
CustomizableSkeletalComponent - > SetPhysicsAsset (
CustomizableObjectInstance . SkeletalMeshes [ CustomizableSkeletalComponent - > ComponentIndex ] ?
CustomizableObjectInstance . SkeletalMeshes [ CustomizableSkeletalComponent - > ComponentIndex ] - > GetPhysicsAsset ( ) : nullptr ) ;
}
}
}
CustomizableObjectInstancePrivateData - > SetCOInstanceFlags ( Generated ) ;
CustomizableObjectInstancePrivateData - > ClearCOInstanceFlags ( CreatingSkeletalMesh ) ;
CustomizableObjectInstance . bEditorPropertyChanged = false ;
2023-07-28 06:06:02 -04:00
FinishUpdateGlobal ( & CustomizableObjectInstance , UpdateResult , UpdateCallback , UpdatedDescriptorRuntimeHash ) ;
2023-04-06 16:56:51 -04:00
}
2023-06-22 06:24:44 -04:00
void FCustomizableObjectSystemPrivate : : GetMipStreamingConfig ( const UCustomizableObjectInstance & Instance , bool & bOutNeverStream , int32 & OutMipsToSkip ) const
2022-09-26 15:12:13 -04:00
{
2022-11-03 14:23:46 -04:00
const FString CurrentState = Instance . GetCurrentState ( ) ;
const FParameterUIData * State = Instance . GetCustomizableObject ( ) - > StateUIDataMap . Find ( CurrentState ) ;
2023-03-08 04:37:54 -05:00
// \TODO: This should be controllable independently
2023-06-22 06:24:44 -04:00
bOutNeverStream = State ? State - > TextureCompressionStrategy ! = ETextureCompressionStrategy : : None : false ;
bool bUseMipmapStreaming = ! bOutNeverStream ;
OutMipsToSkip = 0 ; // 0 means all mips
2022-09-26 15:12:13 -04:00
2023-03-15 07:39:39 -04:00
# if PLATFORM_SUPPORTS_TEXTURE_STREAMING
if ( ! IStreamingManager : : Get ( ) . IsTextureStreamingEnabled ( ) )
{
bUseMipmapStreaming = false ;
}
# else
bUseMipmapStreaming = false ;
# endif
2022-11-03 14:23:46 -04:00
if ( bUseMipmapStreaming & & EnableMutableProgressiveMipStreaming )
2022-09-26 15:12:13 -04:00
{
2023-06-22 06:24:44 -04:00
OutMipsToSkip = 255 ; // This means skip all possible mips until only UTexture::GetStaticMinTextureResidentMipCount() are left
2022-09-26 15:12:13 -04:00
}
2023-06-22 06:24:44 -04:00
}
void FCustomizableObjectSystemPrivate : : InitUpdateSkeletalMesh ( UCustomizableObjectInstance & Instance , EQueuePriorityType Priority , bool bIsCloseDistTick , FInstanceUpdateDelegate * UpdateCallback )
{
MUTABLE_CPUPROFILER_SCOPE ( FCustomizableObjectSystemPrivate : : InitUpdateSkeletalMesh ) ;
check ( IsInGameThread ( ) ) ;
bool bNeverStream = false ;
int32 MipsToSkip = 0 ;
GetMipStreamingConfig ( Instance , bNeverStream , MipsToSkip ) ;
2022-09-26 15:12:13 -04:00
2022-11-03 14:23:46 -04:00
const FDescriptorRuntimeHash UpdateDescriptorHash = Instance . GetUpdateDescriptorRuntimeHash ( ) ;
2023-06-22 06:24:44 -04:00
if ( const FMutablePendingInstanceUpdate * QueueElem = MutablePendingInstanceWork . GetUpdate ( & Instance ) )
2022-09-26 15:12:13 -04:00
{
2023-06-22 06:24:44 -04:00
if ( UpdateDescriptorHash . IsSubset ( FDescriptorRuntimeHash ( QueueElem - > InstanceDescriptor ) ) )
2022-09-26 15:12:13 -04:00
{
2023-07-28 06:06:02 -04:00
FinishUpdateGlobal ( & Instance , EUpdateResult : : ErrorOptimized , UpdateCallback ) ;
2022-11-03 14:23:46 -04:00
return ; // The the requested update is equal to the last enqueued update.
2022-09-26 15:12:13 -04:00
}
2023-07-21 03:28:52 -04:00
}
2022-10-20 12:58:14 -04:00
2022-11-03 14:23:46 -04:00
if ( CurrentMutableOperation & &
2023-07-21 03:28:52 -04:00
& Instance = = CurrentMutableOperation - > CustomizableObjectInstance & &
2022-11-03 14:23:46 -04:00
UpdateDescriptorHash . IsSubset ( CurrentMutableOperation - > InstanceDescriptorRuntimeHash ) )
{
2023-07-28 06:06:02 -04:00
FinishUpdateGlobal ( & Instance , EUpdateResult : : ErrorOptimized , UpdateCallback ) ;
2023-01-24 08:45:18 -05:00
return ; // The requested update is equal to the running update.
2022-11-03 14:23:46 -04:00
}
2022-11-04 09:18:44 -04:00
2022-11-03 14:23:46 -04:00
// These delegates must be called at the end of the begin update.
Instance . BeginUpdateDelegate . Broadcast ( & Instance ) ;
Instance . BeginUpdateNativeDelegate . Broadcast ( & Instance ) ;
2022-09-26 15:12:13 -04:00
2023-08-14 10:47:31 -04:00
if ( UpdateDescriptorHash . IsSubset ( Instance . GetDescriptorRuntimeHash ( ) ) & &
! ( CurrentMutableOperation & &
& Instance = = CurrentMutableOperation - > CustomizableObjectInstance ) ) // This condition is necessary because even if the descriptor is a subset, it will be replaced by the CurrentMutableOperation
2022-11-03 14:23:46 -04:00
{
2023-06-02 10:39:09 -04:00
Instance . SkeletalMeshStatus = ESkeletalMeshState : : Correct ; // TODO FutureGMT MTBL-1033 should not be here. Move to UCustomizableObjectInstance::Updated
2023-04-06 16:56:51 -04:00
UpdateSkeletalMesh ( Instance , Instance . GetDescriptorRuntimeHash ( ) , EUpdateResult : : Success , UpdateCallback ) ;
2022-09-26 15:12:13 -04:00
}
2022-10-10 07:09:51 -04:00
else
2023-07-28 06:06:02 -04:00
{
// Cache Texture Parameters being used during the update:
check ( ImageProvider ) ;
// Cache new Texture Parameters
for ( const FCustomizableObjectTextureParameterValue & TextureParameters : Instance . GetDescriptor ( ) . GetTextureParameters ( ) )
{
ImageProvider - > CacheImage ( TextureParameters . ParameterValue , false ) ;
2023-07-31 03:24:06 -04:00
for ( const FName & TextureParameter : TextureParameters . ParameterRangeValues )
2023-07-28 06:06:02 -04:00
{
ImageProvider - > CacheImage ( TextureParameter , false ) ;
}
}
UCustomizableInstancePrivateData * InstancePrivate = Instance . GetPrivate ( ) ;
check ( InstancePrivate ) ;
// Uncache old Texture Parameters
2023-07-31 03:24:06 -04:00
for ( const FName & TextureParameter : InstancePrivate - > UpdateTextureParameters )
2023-07-28 06:06:02 -04:00
{
ImageProvider - > UnCacheImage ( TextureParameter , false ) ;
}
// Update which ones are currently are being used
InstancePrivate - > UpdateTextureParameters . Reset ( ) ;
for ( const FCustomizableObjectTextureParameterValue & TextureParameters : Instance . GetDescriptor ( ) . GetTextureParameters ( ) )
{
InstancePrivate - > UpdateTextureParameters . Add ( TextureParameters . ParameterValue ) ;
2023-07-31 03:24:06 -04:00
for ( const FName & TextureParameter : TextureParameters . ParameterRangeValues )
2023-07-28 06:06:02 -04:00
{
InstancePrivate - > UpdateTextureParameters . Add ( TextureParameter ) ;
}
}
2023-01-24 08:45:18 -05:00
Instance . SkeletalMeshStatus = ESkeletalMeshState : : AsyncUpdatePending ;
2023-04-06 16:56:51 -04:00
2023-06-22 06:24:44 -04:00
if ( ! bIsCloseDistTick ) // When called from bIsCloseDistTick, the update operation is directly processed without going to a queue first
{
const FMutablePendingInstanceUpdate InstanceUpdate ( & Instance , Priority , UpdateCallback , bNeverStream , MipsToSkip ) ;
MutablePendingInstanceWork . AddUpdate ( InstanceUpdate ) ;
}
2022-10-10 07:09:51 -04:00
}
2022-09-26 15:12:13 -04:00
}
void FCustomizableObjectSystemPrivate : : InitDiscardResourcesSkeletalMesh ( UCustomizableObjectInstance * InCustomizableObjectInstance )
{
check ( IsInGameThread ( ) ) ;
if ( InCustomizableObjectInstance & & InCustomizableObjectInstance - > IsValidLowLevel ( ) )
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( InCustomizableObjectInstance - > GetPrivate ( ) ! = nullptr ) ;
2023-06-22 06:24:44 -04:00
MutablePendingInstanceWork . AddDiscard ( FMutablePendingInstanceDiscard ( InCustomizableObjectInstance ) ) ;
2022-09-26 15:12:13 -04:00
}
}
2023-01-10 15:48:59 -05:00
void FCustomizableObjectSystemPrivate : : InitInstanceIDRelease ( mu : : Instance : : ID IDToRelease )
{
check ( IsInGameThread ( ) ) ;
2023-06-22 06:24:44 -04:00
MutablePendingInstanceWork . AddIDRelease ( IDToRelease ) ;
2023-01-10 15:48:59 -05:00
}
2022-09-26 15:12:13 -04:00
bool UCustomizableObjectSystem : : IsReplaceDiscardedWithReferenceMeshEnabled ( ) const
{
if ( Private . IsValid ( ) )
{
return Private - > IsReplaceDiscardedWithReferenceMeshEnabled ( ) ;
}
return false ;
}
void UCustomizableObjectSystem : : SetReplaceDiscardedWithReferenceMeshEnabled ( bool bIsEnabled )
{
if ( Private . IsValid ( ) )
{
Private - > SetReplaceDiscardedWithReferenceMeshEnabled ( bIsEnabled ) ;
}
}
void UCustomizableObjectSystem : : ClearResourceCacheProtected ( )
{
check ( IsInGameThread ( ) ) ;
ProtectedCachedTextures . Reset ( 0 ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( GetPrivate ( ) ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
GetPrivate ( ) - > ProtectedObjectCachedImages . Reset ( 0 ) ;
}
# if WITH_EDITOR
bool UCustomizableObjectSystem : : LockObject ( const class UCustomizableObject * InObject )
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( InObject ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
check ( ! InObject - > GetPrivate ( ) - > bLocked ) ;
2022-11-24 10:07:28 -05:00
check ( IsInGameThread ( ) & & ! IsInParallelGameThread ( ) ) ;
2022-09-26 15:12:13 -04:00
2023-06-12 11:06:50 -04:00
if ( InObject & & InObject - > GetPrivate ( ) & & Private )
2022-09-26 15:12:13 -04:00
{
2023-06-12 11:06:50 -04:00
// If the current instance is for this object, make the lock fail by returning false
if ( Private - > CurrentInstanceBeingUpdated & &
Private - > CurrentInstanceBeingUpdated - > GetCustomizableObject ( ) = = InObject )
{
UE_LOG ( LogMutable , Warning , TEXT ( " ---- failed to lock object %s " ) , * InObject - > GetName ( ) ) ;
return false ;
}
FString Message = FString : : Printf ( TEXT ( " Customizable Object %s has pending texture streaming operations. Please wait a few seconds and try again. " ) ,
* InObject - > GetName ( ) ) ;
// Pre-check pending operations before locking. This check is redundant and incomplete because it's checked again after locking
// and some operations may start between here and the actual lock. But in the CO Editor preview it will prevent some
// textures getting stuck at low resolution when they try to update mips and are cancelled when the user presses
// the compile button but the compilation quits anyway because there are pending operations
if ( CheckIfDiskOrMipUpdateOperationsPending ( * InObject ) )
{
UE_LOG ( LogMutable , Warning , TEXT ( " %s " ) , * Message ) ;
return false ;
}
// Lock the object, no new file or mip streaming operations should start from this point
InObject - > GetPrivate ( ) - > bLocked = true ;
// But some could have started between the first CheckIfDiskOrMipUpdateOperationsPending and the lock a few lines back, so check again
if ( CheckIfDiskOrMipUpdateOperationsPending ( * InObject ) )
{
UE_LOG ( LogMutable , Warning , TEXT ( " %s " ) , * Message ) ;
// Unlock and return because the pending operations cannot be easily stopped now, the compilation hasn't started and the CO
// hasn't changed state yet. It's simpler to quit the compilation, unlock and let the user try to compile again
InObject - > GetPrivate ( ) - > bLocked = false ;
return false ;
}
// Ensure that we don't try to handle any further streaming operations for this object
check ( GetPrivate ( ) ! = nullptr ) ;
if ( GetPrivate ( ) - > Streamer )
{
GetPrivate ( ) - > Streamer - > CancelStreamingForObject ( InObject ) ;
}
// Clear the cache for the instance, since we will remake it
FMutableResourceCache & Cache = GetPrivate ( ) - > GetObjectCache ( InObject ) ;
Cache . Clear ( ) ;
check ( InObject - > GetPrivate ( ) - > bLocked ) ;
return true ;
}
else
{
FString ObjectName = InObject ? InObject - > GetName ( ) : FString ( " null " ) ;
UE_LOG ( LogMutable , Warning , TEXT ( " Failed to lock the object [%s] because it was null or the system was null or partially destroyed. " ) , * ObjectName ) ;
2022-11-24 10:07:28 -05:00
return false ;
}
2022-09-26 15:12:13 -04:00
}
void UCustomizableObjectSystem : : UnlockObject ( const class UCustomizableObject * Obj )
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Obj ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
check ( Obj - > GetPrivate ( ) - > bLocked ) ;
2022-11-24 10:07:28 -05:00
check ( IsInGameThread ( ) & & ! IsInParallelGameThread ( ) ) ;
2023-06-12 11:06:50 -04:00
if ( Obj & & Obj - > GetPrivate ( ) )
{
Obj - > GetPrivate ( ) - > bLocked = false ;
}
2022-09-26 15:12:13 -04:00
}
2022-11-24 10:07:28 -05:00
bool UCustomizableObjectSystem : : CheckIfDiskOrMipUpdateOperationsPending ( const UCustomizableObject & Object ) const
{
for ( TObjectIterator < UCustomizableObjectInstance > CustomizableObjectInstance ; CustomizableObjectInstance ; + + CustomizableObjectInstance )
{
if ( CustomizableObjectInstance - > GetCustomizableObject ( ) = = & Object )
{
for ( const FGeneratedTexture & GeneratedTexture : CustomizableObjectInstance - > GetPrivate ( ) - > GeneratedTextures )
{
if ( GeneratedTexture . Texture - > HasPendingInitOrStreaming ( ) )
{
return true ;
}
}
}
}
// Ensure that we don't try to handle any further streaming operations for this object
check ( GetPrivate ( ) ) ;
2023-06-26 02:16:47 -04:00
if ( const FUnrealMutableModelBulkReader * Streamer = GetPrivate ( ) - > Streamer . Get ( ) )
2022-11-24 10:07:28 -05:00
{
if ( Streamer - > AreTherePendingStreamingOperationsForObject ( & Object ) )
{
return true ;
}
}
return false ;
}
2022-09-26 15:12:13 -04:00
void UCustomizableObjectSystem : : EditorSettingsChanged ( const FEditorCompileSettings & InEditorSettings )
{
EditorSettings = InEditorSettings ;
}
bool UCustomizableObjectSystem : : IsCompilationDisabled ( ) const
{
return EditorSettings . bDisableCompilation ;
}
bool UCustomizableObjectSystem : : IsAutoCompileEnabled ( ) const
{
return EditorSettings . bEnableAutomaticCompilation ;
}
bool UCustomizableObjectSystem : : IsAutoCompilationSync ( ) const
{
return EditorSettings . bCompileObjectsSynchronously ;
}
# endif
void UCustomizableObjectSystem : : PurgePendingReleaseSkeletalMesh ( )
{
MUTABLE_CPUPROFILER_SCOPE ( UCustomizableObjectSystem : : PurgePendingReleaseSkeletalMesh ) ;
double CurTime = FPlatformTime : : Seconds ( ) ;
static double TimeToDelete = 1.0 ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
for ( int32 InfoIndex = PendingReleaseSkeletalMesh . Num ( ) - 1 ; InfoIndex > = 0 ; - - InfoIndex )
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
FPendingReleaseSkeletalMeshInfo & Info = PendingReleaseSkeletalMesh [ InfoIndex ] ;
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
if ( Info . SkeletalMesh ! = nullptr )
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
if ( ( CurTime - Info . TimeStamp ) > = TimeToDelete )
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
if ( Info . SkeletalMesh - > GetSkeleton ( ) )
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
Info . SkeletalMesh - > GetSkeleton ( ) - > ClearCacheData ( ) ;
2022-09-26 15:12:13 -04:00
}
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
Info . SkeletalMesh - > GetRefSkeleton ( ) . Empty ( ) ;
Info . SkeletalMesh - > GetMaterials ( ) . Empty ( ) ;
Info . SkeletalMesh - > GetRefBasesInvMatrix ( ) . Empty ( ) ;
Info . SkeletalMesh - > ReleaseResources ( ) ;
Info . SkeletalMesh - > ReleaseResourcesFence . Wait ( ) ;
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
PendingReleaseSkeletalMesh . RemoveAt ( InfoIndex ) ;
2022-09-26 15:12:13 -04:00
}
}
}
}
2023-08-10 14:14:20 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
void UCustomizableObjectSystem : : AddPendingReleaseSkeletalMesh ( USkeletalMesh * SkeletalMesh )
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( SkeletalMesh ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
FPendingReleaseSkeletalMeshInfo Info ;
Info . SkeletalMesh = SkeletalMesh ;
Info . TimeStamp = FPlatformTime : : Seconds ( ) ;
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
PendingReleaseSkeletalMesh . Add ( Info ) ;
2022-09-26 15:12:13 -04:00
}
void UCustomizableObjectSystem : : ClearCurrentMutableOperation ( )
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
Private - > CurrentInstanceBeingUpdated = nullptr ;
Private - > CurrentMutableOperation = nullptr ;
ClearResourceCacheProtected ( ) ;
}
2023-05-24 02:50:03 -04:00
void FCustomizableObjectSystemPrivate : : UpdateMemoryLimit ( )
2022-09-26 15:12:13 -04:00
{
// This must run on game thread, and when the mutable thread is not running
check ( IsInGameThread ( ) ) ;
2023-05-24 02:50:03 -04:00
const uint64 MemoryBytes = CVarWorkingMemory . GetValueOnGameThread ( ) * 1024 ;
if ( MemoryBytes ! = LastWorkingMemoryBytes )
2022-09-26 15:12:13 -04:00
{
2023-05-24 02:50:03 -04:00
LastWorkingMemoryBytes = MemoryBytes ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( MutableSystem ) ;
2023-05-24 02:50:03 -04:00
MutableSystem - > SetWorkingMemoryBytes ( MemoryBytes ) ;
2022-09-26 15:12:13 -04:00
}
2023-06-26 02:16:47 -04:00
const uint32 GeneratedResourceCacheSize = CVarGeneratedResourcesCacheSize . GetValueOnGameThread ( ) ;
if ( GeneratedResourceCacheSize ! = LastGeneratedResourceCacheSize )
{
LastGeneratedResourceCacheSize = GeneratedResourceCacheSize ;
check ( MutableSystem ) ;
MutableSystem - > SetGeneratedCacheSize ( GeneratedResourceCacheSize ) ;
}
2022-09-26 15:12:13 -04:00
}
// Asynchronous tasks performed during the creation or update of a mutable instance.
// Check the documentation before modifying and keep it up to date.
// https://docs.google.com/drawings/d/109NlsdKVxP59K5TuthJkleVG3AROkLJr6N03U4bNp4s
// When it says "mutable thread" it means any task pool thread, but with the guarantee that no other thread is using the mutable runtime.
// Naming: Task_<thread>_<description>
namespace impl
{
2023-04-25 06:07:49 -04:00
void Subtask_Mutable_UpdateParameterRelevancy ( const TSharedPtr < FMutableOperationData > & OperationData , const mu : : Parameters * MutableParameters )
2022-09-26 15:12:13 -04:00
{
2023-04-25 06:07:49 -04:00
MUTABLE_CPUPROFILER_SCOPE ( Subtask_Mutable_UpdateParameterRelevancy )
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( OperationData ) ;
2022-09-26 15:12:13 -04:00
OperationData - > RelevantParametersInProgress . Empty ( ) ;
check ( MutableParameters ) ;
2023-04-25 06:07:49 -04:00
check ( OperationData - > InstanceID ! = 0 ) ;
2022-09-26 15:12:13 -04:00
// This must run in the mutable thread.
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( UCustomizableObjectSystem : : GetInstance ( ) ! = nullptr ) ;
check ( UCustomizableObjectSystem : : GetInstance ( ) - > GetPrivate ( ) ! = nullptr ) ;
mu : : SystemPtr MutableSystem = UCustomizableObjectSystem : : GetInstance ( ) - > GetPrivate ( ) - > MutableSystem ;
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
int32 NumParameters = MutableParameters - > GetCount ( ) ;
2022-09-26 15:12:13 -04:00
// Update the parameter relevancy.
{
MUTABLE_CPUPROFILER_SCOPE ( ParameterRelevancy )
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
TArray < bool > Relevant ;
Relevant . SetNumZeroed ( NumParameters ) ;
2023-04-25 06:07:49 -04:00
MutableSystem - > GetParameterRelevancy ( OperationData - > InstanceID , MutableParameters , Relevant . GetData ( ) ) ;
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
for ( int32 ParamIndex = 0 ; ParamIndex < NumParameters ; + + ParamIndex )
2022-09-26 15:12:13 -04:00
{
2023-04-25 06:07:49 -04:00
if ( Relevant [ ParamIndex ] )
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
OperationData - > RelevantParametersInProgress . Add ( ParamIndex ) ;
2022-09-26 15:12:13 -04:00
}
}
}
}
2023-03-23 08:20:51 -04:00
// This runs in the mutable thread.
2022-12-09 03:57:57 -05:00
void Subtask_Mutable_BeginUpdate_GetMesh ( const TSharedPtr < FMutableOperationData > & OperationData , TSharedPtr < mu : : Model , ESPMode : : ThreadSafe > Model , const mu : : Parameters * MutableParameters , int32 State )
2022-09-26 15:12:13 -04:00
{
2023-03-23 08:20:51 -04:00
MUTABLE_CPUPROFILER_SCOPE ( Subtask_Mutable_BeginUpdate_GetMesh )
2022-09-26 15:12:13 -04:00
check ( MutableParameters ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( OperationData ) ;
2022-09-26 15:12:13 -04:00
OperationData - > InstanceUpdateData . Clear ( ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( UCustomizableObjectSystem : : GetInstance ( ) ! = nullptr ) ;
check ( UCustomizableObjectSystem : : GetInstance ( ) - > GetPrivate ( ) ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
mu : : System * System = UCustomizableObjectSystem : : GetInstance ( ) - > GetPrivate ( ) - > MutableSystem . get ( ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( System ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
2023-01-10 15:48:59 -05:00
if ( OperationData - > bLiveUpdateMode )
{
if ( OperationData - > InstanceID = = 0 )
{
// It's the first update since the instance was put in LiveUpdate Mode, this ID will be reused from now on
OperationData - > InstanceID = System - > NewInstance ( Model ) ;
UE_LOG ( LogMutable , Verbose , TEXT ( " Creating Mutable instance with id [%d] for reuse " ) , OperationData - > InstanceID ) ;
}
else
{
// The instance was already in LiveUpdate Mode, the ID is reused
check ( OperationData - > InstanceID ) ;
UE_LOG ( LogMutable , Verbose , TEXT ( " Reusing Mutable instance with id [%d] " ) , OperationData - > InstanceID ) ;
}
}
else
{
// In non-LiveUpdate mode, we are forcing the recreation of mutable-side instances with every update.
check ( OperationData - > InstanceID = = 0 ) ;
OperationData - > InstanceID = System - > NewInstance ( Model ) ;
UE_LOG ( LogMutable , Verbose , TEXT ( " Creating Mutable instance with id [%d] " ) , OperationData - > InstanceID ) ;
}
check ( OperationData - > InstanceID ! = 0 ) ;
2022-09-26 15:12:13 -04:00
const mu : : Instance * Instance = nullptr ;
// Main instance generation step
{
// LOD mask, set to all ones to build all LODs
2023-03-08 04:37:54 -05:00
uint32 LODMask = mu : : System : : AllLODs ;
2022-09-26 15:12:13 -04:00
Instance = System - > BeginUpdate ( OperationData - > InstanceID , MutableParameters , State , LODMask ) ;
if ( ! Instance )
{
2023-04-27 05:10:23 -04:00
UE_LOG ( LogMutable , Warning , TEXT ( " An Instace update has failed. " ) ) ;
2022-09-26 15:12:13 -04:00
return ;
}
}
OperationData - > NumLODsAvailable = Instance - > GetLODCount ( ) ;
if ( OperationData - > CurrentMinLOD > = OperationData - > NumLODsAvailable )
{
OperationData - > CurrentMinLOD = OperationData - > NumLODsAvailable - 1 ;
OperationData - > CurrentMaxLOD = OperationData - > CurrentMinLOD ;
}
else if ( OperationData - > CurrentMaxLOD > = OperationData - > NumLODsAvailable )
{
OperationData - > CurrentMaxLOD = OperationData - > NumLODsAvailable - 1 ;
}
2023-01-24 08:45:18 -05:00
if ( ! OperationData - > RequestedLODs . IsEmpty ( ) )
{
// Initialize RequestedLODs to zero if not set
const int32 ComponentCount = Instance - > GetComponentCount ( OperationData - > CurrentMinLOD ) ;
OperationData - > RequestedLODs . SetNumZeroed ( ComponentCount ) ;
for ( int32 ComponentIndex = 0 ; ComponentIndex < ComponentCount ; + + ComponentIndex )
{
// Ensure we're generating at least one LOD
if ( OperationData - > RequestedLODs [ ComponentIndex ] = = 0 )
{
OperationData - > RequestedLODs [ ComponentIndex ] | = ( 1 < < OperationData - > CurrentMaxLOD ) ;
}
2023-02-02 05:05:17 -05:00
// Make sure we are not requesting a LOD that doesn't exist in this state (Essentially for states with bBuildOnlyFirstLOD
// and NumExtraLODsToBuildPerPlatform when the ExtraLOD is not needed)
if ( ( OperationData - > RequestedLODs [ ComponentIndex ] & ( 1 < < OperationData - > CurrentMaxLOD ) ) = = 0 )
{
OperationData - > CurrentMaxLOD = OperationData - > CurrentMinLOD ;
// Ensure the fallback LOD actually exists
OperationData - > RequestedLODs [ ComponentIndex ] | = ( 1 < < OperationData - > CurrentMaxLOD ) ;
}
2023-01-24 08:45:18 -05:00
}
}
2023-05-10 08:29:50 -04:00
// Map SharedSurfaceId to surface index
TArray < int32 > SurfacesSharedId ;
2022-09-26 15:12:13 -04:00
// Generate the mesh and gather all the required resource Ids
OperationData - > InstanceUpdateData . LODs . SetNum ( Instance - > GetLODCount ( ) ) ;
for ( int32 MutableLODIndex = 0 ; MutableLODIndex < Instance - > GetLODCount ( ) ; + + MutableLODIndex )
{
// Skip LODs outside the reange we want to generate
if ( MutableLODIndex < OperationData - > CurrentMinLOD | | MutableLODIndex > OperationData - > CurrentMaxLOD )
{
continue ;
}
FInstanceUpdateData : : FLOD & LOD = OperationData - > InstanceUpdateData . LODs [ MutableLODIndex ] ;
LOD . FirstComponent = OperationData - > InstanceUpdateData . Components . Num ( ) ;
LOD . ComponentCount = Instance - > GetComponentCount ( MutableLODIndex ) ;
2023-01-24 08:45:18 -05:00
const FInstanceGeneratedData : : FLOD & PrevUpdateLODData = OperationData - > LastUpdateData . LODs . IsValidIndex ( MutableLODIndex ) ?
OperationData - > LastUpdateData . LODs [ MutableLODIndex ] : FInstanceGeneratedData : : FLOD ( ) ;
2022-09-26 15:12:13 -04:00
for ( int32 ComponentIndex = 0 ; ComponentIndex < LOD . ComponentCount ; + + ComponentIndex )
{
OperationData - > InstanceUpdateData . Components . Push ( FInstanceUpdateData : : FComponent ( ) ) ;
FInstanceUpdateData : : FComponent & Component = OperationData - > InstanceUpdateData . Components . Last ( ) ;
Component . Id = Instance - > GetComponentId ( MutableLODIndex , ComponentIndex ) ;
Component . FirstSurface = OperationData - > InstanceUpdateData . Surfaces . Num ( ) ;
Component . SurfaceCount = 0 ;
2023-01-24 08:45:18 -05:00
const FInstanceGeneratedData : : FComponent & PrevUpdateComponent = OperationData - > LastUpdateData . Components . IsValidIndex ( PrevUpdateLODData . FirstComponent + ComponentIndex ) ?
OperationData - > LastUpdateData . Components [ PrevUpdateLODData . FirstComponent + ComponentIndex ] : FInstanceGeneratedData : : FComponent ( ) ;
const bool bGenerateLOD = OperationData - > RequestedLODs . IsValidIndex ( Component . Id ) ? ( OperationData - > RequestedLODs [ Component . Id ] & ( 1 < < MutableLODIndex ) ) ! = 0 : true ;
2022-09-26 15:12:13 -04:00
// Mesh
if ( Instance - > GetMeshCount ( MutableLODIndex , ComponentIndex ) > 0 )
{
MUTABLE_CPUPROFILER_SCOPE ( GetMesh ) ;
2023-01-24 08:45:18 -05:00
Component . MeshID = Instance - > GetMeshId ( MutableLODIndex , ComponentIndex , 0 ) ;
2022-09-26 15:12:13 -04:00
// Mesh cache is not enabled yet.
//auto CachedMesh = Cache.Meshes.Find(meshId);
//if (CachedMesh && CachedMesh->IsValid(false, true))
//{
// UE_LOG(LogMutable, Verbose, TEXT("Mesh resource with id [%d] can be cached."), meshId);
// INC_DWORD_STAT(STAT_MutableNumCachedSkeletalMeshes);
//}
2023-01-24 08:45:18 -05:00
// Check if we can use data from the currently generated SkeletalMesh
Component . bReuseMesh = OperationData - > bCanReuseGeneratedData & & PrevUpdateComponent . bGenerated ? PrevUpdateComponent . MeshID = = Component . MeshID : false ;
if ( bGenerateLOD & & ! Component . bReuseMesh )
{
Component . Mesh = System - > GetMesh ( OperationData - > InstanceID , Component . MeshID ) ;
}
2022-09-26 15:12:13 -04:00
}
2023-01-24 08:45:18 -05:00
if ( ! Component . Mesh & & ! Component . bReuseMesh )
2022-09-26 15:12:13 -04:00
{
continue ;
}
2023-01-24 08:45:18 -05:00
Component . bGenerated = true ;
const int32 SurfaceCount = Component . Mesh ? Component . Mesh - > GetSurfaceCount ( ) : PrevUpdateComponent . SurfaceCount ;
2022-09-26 15:12:13 -04:00
// Materials and images
2023-01-24 08:45:18 -05:00
for ( int32 MeshSurfaceIndex = 0 ; MeshSurfaceIndex < SurfaceCount ; + + MeshSurfaceIndex )
2022-09-26 15:12:13 -04:00
{
2023-01-24 08:45:18 -05:00
uint32 SurfaceId = Component . Mesh ? Component . Mesh - > GetSurfaceId ( MeshSurfaceIndex ) : OperationData - > LastUpdateData . SurfaceIds [ PrevUpdateComponent . FirstSurface + MeshSurfaceIndex ] ;
2022-10-04 07:53:49 -04:00
int32 InstanceSurfaceIndex = Instance - > FindSurfaceById ( MutableLODIndex , ComponentIndex , SurfaceId ) ;
2023-01-24 08:45:18 -05:00
check ( Component . bReuseMesh | | Component . Mesh - > GetVertexCount ( ) = = 0 | | InstanceSurfaceIndex > = 0 ) ;
2022-09-26 15:12:13 -04:00
2023-05-10 08:29:50 -04:00
int32 BaseSurfaceIndex = InstanceSurfaceIndex ;
int32 BaseLODIndex = MutableLODIndex ;
2022-09-26 15:12:13 -04:00
if ( InstanceSurfaceIndex > = 0 )
{
OperationData - > InstanceUpdateData . Surfaces . Push ( { } ) ;
FInstanceUpdateData : : FSurface & Surface = OperationData - > InstanceUpdateData . Surfaces . Last ( ) ;
+ + Component . SurfaceCount ;
2023-07-28 02:20:23 -04:00
// Now Surface.MaterialIndex is decoded from a parameter at the end of this if()
2022-10-04 07:53:49 -04:00
Surface . SurfaceId = SurfaceId ;
2022-09-26 15:12:13 -04:00
2023-05-10 08:29:50 -04:00
const int32 SharedSurfaceId = Instance - > GetSharedSurfaceId ( MutableLODIndex , ComponentIndex , InstanceSurfaceIndex ) ;
const int32 SharedSurfaceIndex = SurfacesSharedId . Find ( SharedSurfaceId ) ;
SurfacesSharedId . Add ( SharedSurfaceId ) ;
if ( SharedSurfaceId ! = INDEX_NONE )
{
if ( SharedSurfaceIndex > = 0 )
{
Surface = OperationData - > InstanceUpdateData . Surfaces [ SharedSurfaceIndex ] ;
continue ;
}
// Find the first LOD where this surface can be found
Instance - > FindBaseSurfaceBySharedId ( ComponentIndex , SharedSurfaceId , BaseSurfaceIndex , BaseLODIndex ) ;
Surface . SurfaceId = Instance - > GetSurfaceId ( BaseLODIndex , ComponentIndex , BaseSurfaceIndex ) ;
}
2022-09-26 15:12:13 -04:00
// Images
Surface . FirstImage = OperationData - > InstanceUpdateData . Images . Num ( ) ;
2023-07-20 07:38:13 -04:00
Surface . ImageCount = Instance - > GetImageCount ( BaseLODIndex , ComponentIndex , InstanceSurfaceIndex ) ;
2022-09-26 15:12:13 -04:00
for ( int32 ImageIndex = 0 ; ImageIndex < Surface . ImageCount ; + + ImageIndex )
{
MUTABLE_CPUPROFILER_SCOPE ( GetImageId ) ;
OperationData - > InstanceUpdateData . Images . Push ( { } ) ;
FInstanceUpdateData : : FImage & Image = OperationData - > InstanceUpdateData . Images . Last ( ) ;
2023-07-20 07:38:13 -04:00
Image . Name = Instance - > GetImageName ( BaseLODIndex , ComponentIndex , InstanceSurfaceIndex , ImageIndex ) ;
2023-05-10 08:29:50 -04:00
Image . ImageID = Instance - > GetImageId ( BaseLODIndex , ComponentIndex , BaseSurfaceIndex , ImageIndex ) ;
2022-09-26 15:12:13 -04:00
Image . FullImageSizeX = 0 ;
Image . FullImageSizeY = 0 ;
2023-05-10 08:29:50 -04:00
Image . BaseLOD = BaseLODIndex ;
2022-09-26 15:12:13 -04:00
}
// Vectors
Surface . FirstVector = OperationData - > InstanceUpdateData . Vectors . Num ( ) ;
2023-07-20 07:38:13 -04:00
Surface . VectorCount = Instance - > GetVectorCount ( BaseLODIndex , ComponentIndex , InstanceSurfaceIndex ) ;
2022-09-26 15:12:13 -04:00
for ( int32 VectorIndex = 0 ; VectorIndex < Surface . VectorCount ; + + VectorIndex )
{
MUTABLE_CPUPROFILER_SCOPE ( GetVector ) ;
OperationData - > InstanceUpdateData . Vectors . Push ( { } ) ;
FInstanceUpdateData : : FVector & Vector = OperationData - > InstanceUpdateData . Vectors . Last ( ) ;
2023-07-20 07:38:13 -04:00
Vector . Name = Instance - > GetVectorName ( BaseLODIndex , ComponentIndex , InstanceSurfaceIndex , VectorIndex ) ;
Vector . Vector = Instance - > GetVector ( BaseLODIndex , ComponentIndex , InstanceSurfaceIndex , VectorIndex ) ;
2022-09-26 15:12:13 -04:00
}
// Scalars
Surface . FirstScalar = OperationData - > InstanceUpdateData . Scalars . Num ( ) ;
2023-07-20 07:38:13 -04:00
Surface . ScalarCount = Instance - > GetScalarCount ( BaseLODIndex , ComponentIndex , InstanceSurfaceIndex ) ;
2022-09-26 15:12:13 -04:00
for ( int32 ScalarIndex = 0 ; ScalarIndex < Surface . ScalarCount ; + + ScalarIndex )
{
2023-07-28 02:20:23 -04:00
MUTABLE_CPUPROFILER_SCOPE ( GetScalar )
FString ScalarName = Instance - > GetScalarName ( BaseLODIndex , ComponentIndex , InstanceSurfaceIndex , ScalarIndex ) ;
float ScalarValue = Instance - > GetScalar ( BaseLODIndex , ComponentIndex , InstanceSurfaceIndex , ScalarIndex ) ;
FString EncodingMaterialIdString = " __MutableMaterialId " ;
// Decoding Material Switch from Mutable parameter name
if ( ScalarName . Equals ( EncodingMaterialIdString ) )
{
Surface . MaterialIndex = ( uint32 ) ScalarValue ;
// This parameter is not needed in the final material instance
Surface . ScalarCount - = 1 ;
}
else
{
OperationData - > InstanceUpdateData . Scalars . Push ( { ScalarName , ScalarValue } ) ;
}
2022-09-26 15:12:13 -04:00
}
}
}
}
}
2023-04-05 11:20:44 -04:00
// Copy ExtensionData Object node input from the Instance to the InstanceUpdateData
for ( int32 ExtensionDataIndex = 0 ; ExtensionDataIndex < Instance - > GetExtensionDataCount ( ) ; ExtensionDataIndex + + )
{
mu : : ExtensionDataPtrConst ExtensionData ;
const char * NameAnsi = nullptr ;
Instance - > GetExtensionData ( ExtensionDataIndex , ExtensionData , NameAnsi ) ;
check ( ExtensionData ) ;
check ( NameAnsi ) ;
FInstanceUpdateData : : FNamedExtensionData & NewEntry = OperationData - > InstanceUpdateData . ExtendedInputPins . AddDefaulted_GetRef ( ) ;
NewEntry . Data = ExtensionData ;
NewEntry . Name = NameAnsi ;
check ( NewEntry . Name ! = NAME_None ) ;
}
2022-09-26 15:12:13 -04:00
}
2023-03-23 08:20:51 -04:00
// This runs in the mutable thread.
2022-12-09 03:57:57 -05:00
void Subtask_Mutable_GetImages ( const TSharedPtr < FMutableOperationData > & OperationData , TSharedPtr < mu : : Model , ESPMode : : ThreadSafe > Model , const mu : : Parameters * MutableParameters , int32 State )
2022-09-26 15:12:13 -04:00
{
2023-03-23 08:20:51 -04:00
MUTABLE_CPUPROFILER_SCOPE ( Subtask_Mutable_GetImages )
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( OperationData ) ;
2022-09-26 15:12:13 -04:00
check ( MutableParameters ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( UCustomizableObjectSystem : : GetInstance ( ) ! = nullptr ) ;
FCustomizableObjectSystemPrivate * CustomizableObjectSystemPrivateData = UCustomizableObjectSystem : : GetInstance ( ) - > GetPrivate ( ) ;
check ( CustomizableObjectSystemPrivateData ! = nullptr ) ;
mu : : System * System = CustomizableObjectSystemPrivateData - > MutableSystem . get ( ) ;
check ( System ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
// Generate all the required resources, that are not cached
2023-06-26 02:16:47 -04:00
TArray < mu : : FResourceID > ImagesInThisInstance ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
for ( FInstanceUpdateData : : FImage & Image : OperationData - > InstanceUpdateData . Images )
2022-09-26 15:12:13 -04:00
{
MUTABLE_CPUPROFILER_SCOPE ( GetImage ) ;
2023-02-02 02:41:54 -05:00
mu : : FImageDesc ImageDesc ;
2022-09-26 15:12:13 -04:00
// This should only be done when using progressive images, since GetImageDesc does some actual processing.
{
System - > GetImageDesc ( OperationData - > InstanceID , Image . ImageID , ImageDesc ) ;
2023-03-01 12:33:52 -05:00
uint16 MaxTextureSizeToGenerate = uint16 ( CustomizableObjectSystemPrivateData - > MaxTextureSizeToGenerate ) ;
uint16 MaxSize = FMath : : Max ( ImageDesc . m_size [ 0 ] , ImageDesc . m_size [ 1 ] ) ;
uint16 Reduction = 1 ;
if ( MaxTextureSizeToGenerate > 0 & & MaxSize > MaxTextureSizeToGenerate )
{
Reduction = MaxSize / MaxTextureSizeToGenerate ;
}
Image . FullImageSizeX = ImageDesc . m_size [ 0 ] / Reduction ;
Image . FullImageSizeY = ImageDesc . m_size [ 1 ] / Reduction ;
2022-09-26 15:12:13 -04:00
}
2023-06-27 06:04:11 -04:00
const bool bCached = ImagesInThisInstance . Contains ( Image . ImageID ) | | // See if it is cached from this same instance (can happen with LODs)
( CVarReuseImagesBetweenInstances . GetValueOnAnyThread ( ) & & CustomizableObjectSystemPrivateData - > ProtectedObjectCachedImages . Contains ( Image . ImageID ) ) ; // See if it is cached from another instance
2022-09-26 15:12:13 -04:00
if ( bCached )
{
2023-04-27 05:10:23 -04:00
UE_LOG ( LogMutable , VeryVerbose , TEXT ( " Texture resource with id [%d] is cached. " ) , Image . ImageID ) ;
2022-09-26 15:12:13 -04:00
INC_DWORD_STAT ( STAT_MutableNumCachedTextures ) ;
}
else
{
int32 MaxSize = FMath : : Max ( Image . FullImageSizeX , Image . FullImageSizeY ) ;
int32 FullLODCount = FMath : : CeilLogTwo ( MaxSize ) + 1 ;
int32 MinMipsInImage = FMath : : Min ( FullLODCount , UTexture : : GetStaticMinTextureResidentMipCount ( ) ) ;
int32 MaxMipsToSkip = FullLODCount - MinMipsInImage ;
int32 MipsToSkip = FMath : : Min ( MaxMipsToSkip , OperationData - > MipsToSkip ) ;
2023-02-02 02:41:54 -05:00
2023-03-16 13:03:00 -04:00
if ( ! FMath : : IsPowerOfTwo ( Image . FullImageSizeX ) | | ! FMath : : IsPowerOfTwo ( Image . FullImageSizeY ) )
{
// It doesn't make sense to skip mips as non-power-of-two size textures cannot be streamed anyway
MipsToSkip = 0 ;
}
2023-05-26 15:05:33 -04:00
const int32 MipSizeX = FMath : : Max ( Image . FullImageSizeX > > MipsToSkip , 1 ) ;
const int32 MipSizeY = FMath : : Max ( Image . FullImageSizeY > > MipsToSkip , 1 ) ;
2023-02-02 02:41:54 -05:00
if ( MipsToSkip > 0 & & CustomizableObjectSystemPrivateData - > EnableSkipGenerateResidentMips ! = 0 & & OperationData - > LowPriorityTextures . Find ( Image . Name ) ! = INDEX_NONE )
{
2023-06-23 02:01:13 -04:00
Image . Image = new mu : : Image ( MipSizeX , MipSizeY , FullLODCount - MipsToSkip , ImageDesc . m_format , mu : : EInitializationType : : Black ) ;
2023-02-02 02:41:54 -05:00
}
else
{
2023-05-10 08:29:50 -04:00
Image . Image = System - > GetImage ( OperationData - > InstanceID , Image . ImageID , MipsToSkip , Image . BaseLOD ) ;
2023-02-02 02:41:54 -05:00
}
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Image . Image ) ;
2023-04-28 15:57:31 -04:00
// If the image is a reference to an engine texture, we are done.
if ( Image . Image - > IsReference ( ) )
{
continue ;
}
2023-05-26 15:05:33 -04:00
// We should have genrated exactly this size.
bool bSizeMissmatch = Image . Image - > GetSizeX ( ) ! = MipSizeX | | Image . Image - > GetSizeY ( ) ! = MipSizeY ;
if ( bSizeMissmatch )
{
// Generate a correctly-sized but empty image instead, to avoid crashes.
UE_LOG ( LogMutable , Warning , TEXT ( " Mutable generated a wrongly-sized image %d. " ) , Image . ImageID ) ;
2023-06-23 02:01:13 -04:00
Image . Image = new mu : : Image ( MipSizeX , MipSizeY , FullLODCount - MipsToSkip , Image . Image - > GetFormat ( ) , mu : : EInitializationType : : Black ) ;
2023-05-26 15:05:33 -04:00
}
2023-04-28 15:57:31 -04:00
// We need one mip or the complete chain. Otherwise there was a bug.
2022-09-26 15:12:13 -04:00
int32 FullMipCount = Image . Image - > GetMipmapCount ( Image . Image - > GetSizeX ( ) , Image . Image - > GetSizeY ( ) ) ;
int32 RealMipCount = Image . Image - > GetLODCount ( ) ;
2023-05-26 15:05:33 -04:00
bool bForceMipchain =
// Did we fail to generate the entire mipchain (if we have mips at all)?
( RealMipCount ! = 1 ) & & ( RealMipCount ! = FullMipCount ) ;
if ( bForceMipchain )
2022-09-26 15:12:13 -04:00
{
MUTABLE_CPUPROFILER_SCOPE ( GetImage_MipFix ) ;
UE_LOG ( LogMutable , Warning , TEXT ( " Mutable generated an incomplete mip chain for image %d. " ) , Image . ImageID ) ;
// Force the right number of mips. The missing data will be black.
2023-06-23 02:01:13 -04:00
mu : : Ptr < mu : : Image > NewImage = new mu : : Image ( Image . Image - > GetSizeX ( ) , Image . Image - > GetSizeY ( ) , FullMipCount , Image . Image - > GetFormat ( ) , mu : : EInitializationType : : Black ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( NewImage ) ;
2022-09-26 15:12:13 -04:00
if ( NewImage - > GetDataSize ( ) > = Image . Image - > GetDataSize ( ) )
{
FMemory : : Memcpy ( NewImage - > GetData ( ) , Image . Image - > GetData ( ) , Image . Image - > GetDataSize ( ) ) ;
}
Image . Image = NewImage ;
}
ImagesInThisInstance . Add ( Image . ImageID ) ;
}
}
}
2023-03-16 13:03:00 -04:00
2022-09-26 15:12:13 -04:00
2023-03-23 08:20:51 -04:00
// This runs in a worker thread
2022-09-26 15:12:13 -04:00
void Subtask_Mutable_PrepareTextures ( const TSharedPtr < FMutableOperationData > & OperationData )
{
2023-03-23 08:20:51 -04:00
MUTABLE_CPUPROFILER_SCOPE ( Subtask_Mutable_PrepareTextures )
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( OperationData ) ;
2022-09-26 15:12:13 -04:00
for ( const FInstanceUpdateData : : FSurface & Surface : OperationData - > InstanceUpdateData . Surfaces )
{
for ( int32 ImageIndex = 0 ; ImageIndex < Surface . ImageCount ; + + ImageIndex )
{
const FInstanceUpdateData : : FImage & Image = OperationData - > InstanceUpdateData . Images [ Surface . FirstImage + ImageIndex ] ;
FString KeyName = Image . Name ;
mu : : ImagePtrConst MutableImage = Image . Image ;
// If the image is null, it must be in the cache (or repeated in this instance), and we don't need to do anything here.
if ( MutableImage )
{
2023-05-24 09:51:14 -04:00
// Image refences are just references to texture assets and require no work at all
if ( ! MutableImage - > IsReference ( ) )
{
FTexturePlatformData * PlatformData = UCustomizableInstancePrivateData : : MutableCreateImagePlatformData ( MutableImage , - 1 , Image . FullImageSizeX , Image . FullImageSizeY ) ;
OperationData - > ImageToPlatformDataMap . Add ( Image . ImageID , PlatformData ) ;
OperationData - > PendingTextureCoverageQueries . Add ( { KeyName , Surface . MaterialIndex , PlatformData } ) ;
}
2022-09-26 15:12:13 -04:00
}
}
}
}
2023-03-01 12:33:52 -05:00
2022-09-26 15:12:13 -04:00
2023-03-23 08:20:51 -04:00
// This runs in a worker thread
2022-09-26 15:12:13 -04:00
void Subtask_Mutable_PrepareSkeletonData ( const TSharedPtr < FMutableOperationData > & OperationData )
{
2023-03-23 08:20:51 -04:00
MUTABLE_CPUPROFILER_SCOPE ( Subtask_Mutable_PrepareSkeletonData )
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( OperationData ) ;
2022-09-26 15:12:13 -04:00
const int32 LODCount = OperationData - > InstanceUpdateData . LODs . Num ( ) ;
const FInstanceUpdateData : : FLOD & MinLOD = OperationData - > InstanceUpdateData . LODs [ OperationData - > CurrentMinLOD ] ;
const int32 ComponentCount = MinLOD . ComponentCount ;
// Add SkeletonData for each component
OperationData - > InstanceUpdateData . Skeletons . AddDefaulted ( ComponentCount ) ;
for ( int32 ComponentIndex = 0 ; ComponentIndex < ComponentCount ; + + ComponentIndex )
{
2023-01-04 15:46:42 -05:00
FInstanceUpdateData : : FComponent & MinLODComponent = OperationData - > InstanceUpdateData . Components [ MinLOD . FirstComponent + ComponentIndex ] ;
2022-09-26 15:12:13 -04:00
// Set the ComponentIndex
OperationData - > InstanceUpdateData . Skeletons [ ComponentIndex ] . ComponentIndex = MinLODComponent . Id ;
// Fill the data used to generate the RefSkeletalMesh
2023-05-29 10:25:59 -04:00
TArray < uint16 > & SkeletonIds = OperationData - > InstanceUpdateData . Skeletons [ ComponentIndex ] . SkeletonIds ;
2023-06-28 07:02:00 -04:00
TArray < uint16 > & BoneIds = OperationData - > InstanceUpdateData . Skeletons [ ComponentIndex ] . BoneIds ;
TArray < FMatrix44f > & BoneMatricesWithScale = OperationData - > InstanceUpdateData . Skeletons [ ComponentIndex ] . BoneMatricesWithScale ;
2023-01-04 15:46:42 -05:00
2022-09-26 15:12:13 -04:00
// Use first valid LOD bone count as a potential total number of bones, used for pre-allocating data arrays
if ( MinLODComponent . Mesh & & MinLODComponent . Mesh - > GetSkeleton ( ) )
{
const int32 TotalPossibleBones = MinLODComponent . Mesh - > GetSkeleton ( ) - > GetBoneCount ( ) ;
// Out Data
2023-06-28 07:02:00 -04:00
BoneIds . Reserve ( TotalPossibleBones ) ;
2022-09-26 15:12:13 -04:00
BoneMatricesWithScale . Reserve ( TotalPossibleBones ) ;
}
for ( int32 LODIndex = OperationData - > CurrentMinLOD ; LODIndex < = OperationData - > CurrentMaxLOD & & LODIndex < LODCount ; + + LODIndex )
{
MUTABLE_CPUPROFILER_SCOPE ( PrepareSkeletonData_LODs ) ;
const FInstanceUpdateData : : FLOD & CurrentLOD = OperationData - > InstanceUpdateData . LODs [ LODIndex ] ;
FInstanceUpdateData : : FComponent & CurrentLODComponent = OperationData - > InstanceUpdateData . Components [ CurrentLOD . FirstComponent + ComponentIndex ] ;
mu : : MeshPtrConst Mesh = CurrentLODComponent . Mesh ;
2023-06-28 07:02:00 -04:00
if ( ! Mesh )
2022-09-26 15:12:13 -04:00
{
continue ;
}
2022-11-07 04:57:31 -05:00
// Add SkeletonIds
const int32 SkeletonIDsCount = Mesh - > GetSkeletonIDsCount ( ) ;
for ( int32 SkeletonIndex = 0 ; SkeletonIndex < SkeletonIDsCount ; + + SkeletonIndex )
{
SkeletonIds . AddUnique ( Mesh - > GetSkeletonID ( SkeletonIndex ) ) ;
}
2023-06-28 07:02:00 -04:00
// Append BoneMap to the array of BoneMaps
2023-05-10 07:27:16 -04:00
const TArray < uint16 > & BoneMap = Mesh - > GetBoneMap ( ) ;
CurrentLODComponent . FirstBoneMap = OperationData - > InstanceUpdateData . BoneMaps . Num ( ) ;
CurrentLODComponent . BoneMapCount = BoneMap . Num ( ) ;
2023-06-28 07:02:00 -04:00
OperationData - > InstanceUpdateData . BoneMaps . Append ( BoneMap ) ;
2022-09-26 15:12:13 -04:00
2023-05-10 07:27:16 -04:00
// Add active bone indices and poses
2023-01-04 15:46:42 -05:00
const int32 MaxBoneIndex = Mesh - > GetBonePoseCount ( ) ;
CurrentLODComponent . ActiveBones . Reserve ( MaxBoneIndex ) ;
for ( int32 BonePoseIndex = 0 ; BonePoseIndex < MaxBoneIndex ; + + BonePoseIndex )
2022-09-26 15:12:13 -04:00
{
2023-06-28 07:02:00 -04:00
const uint16 BoneId = Mesh - > GetBonePoseBoneId ( BonePoseIndex ) ;
2022-09-26 15:12:13 -04:00
2023-06-28 07:02:00 -04:00
CurrentLODComponent . ActiveBones . Add ( BoneId ) ;
2023-01-04 15:46:42 -05:00
2023-06-28 07:02:00 -04:00
if ( BoneIds . Find ( BoneId ) = = INDEX_NONE )
2023-05-10 07:27:16 -04:00
{
2023-06-28 07:02:00 -04:00
BoneIds . Add ( BoneId ) ;
2023-01-04 15:46:42 -05:00
FTransform3f Transform ;
Mesh - > GetBoneTransform ( BonePoseIndex , Transform ) ;
2023-06-28 07:02:00 -04:00
BoneMatricesWithScale . Emplace ( Transform . Inverse ( ) . ToMatrixWithScale ( ) ) ;
2022-09-26 15:12:13 -04:00
}
}
}
}
}
2023-03-23 08:20:51 -04:00
// This runs in a worker thread.
2023-04-25 06:07:49 -04:00
void Task_Mutable_Update_GetMesh ( TSharedPtr < FMutableOperationData > OperationData , TSharedPtr < mu : : Model , ESPMode : : ThreadSafe > Model , mu : : ParametersPtrConst Parameters , bool bBuildParameterRelevancy , int32 State )
2022-09-26 15:12:13 -04:00
{
2023-03-23 08:20:51 -04:00
MUTABLE_CPUPROFILER_SCOPE ( Task_Mutable_Update_GetMesh )
2022-09-26 15:12:13 -04:00
# if WITH_EDITOR
uint32 StartCycles = FPlatformTime : : Cycles ( ) ;
# endif
check ( OperationData . IsValid ( ) ) ;
Subtask_Mutable_BeginUpdate_GetMesh ( OperationData , Model , Parameters . get ( ) , State ) ;
// TODO: Not strictly mutable: move to another worker thread task to free mutable access?
Subtask_Mutable_PrepareSkeletonData ( OperationData ) ;
2023-04-25 06:07:49 -04:00
if ( bBuildParameterRelevancy )
{
Subtask_Mutable_UpdateParameterRelevancy ( OperationData , Parameters . get ( ) ) ;
}
else
{
OperationData - > RelevantParametersInProgress . Reset ( ) ;
}
2022-09-26 15:12:13 -04:00
# if WITH_EDITOR
uint32 EndCycles = FPlatformTime : : Cycles ( ) ;
OperationData - > MutableRuntimeCycles = EndCycles - StartCycles ;
# endif
}
2022-12-09 03:57:57 -05:00
void Task_Mutable_Update_GetImages ( TSharedPtr < FMutableOperationData > OperationData , TSharedPtr < mu : : Model , ESPMode : : ThreadSafe > Model , mu : : ParametersPtrConst Parameters , int32 State )
2022-09-26 15:12:13 -04:00
{
// This runs in a worker thread.
MUTABLE_CPUPROFILER_SCOPE ( Task_Mutable_GetImages )
# if WITH_EDITOR
uint32 StartCycles = FPlatformTime : : Cycles ( ) ;
# endif
check ( OperationData . IsValid ( ) ) ;
Subtask_Mutable_GetImages ( OperationData , Model , Parameters . get ( ) , State ) ;
// TODO: Not strictly mutable: move to another worker thread task to free mutable access?
Subtask_Mutable_PrepareTextures ( OperationData ) ;
# if WITH_EDITOR
uint32 EndCycles = FPlatformTime : : Cycles ( ) ;
OperationData - > MutableRuntimeCycles + = EndCycles - StartCycles ;
# endif
}
2023-03-23 08:20:51 -04:00
// This runs in a worker thread.
2022-09-26 15:12:13 -04:00
void Task_Mutable_ReleaseInstance ( TSharedPtr < FMutableOperationData > OperationData , mu : : SystemPtr MutableSystem )
{
MUTABLE_CPUPROFILER_SCOPE ( Task_Mutable_ReleaseInstance )
check ( OperationData . IsValid ( ) ) ;
if ( OperationData - > InstanceID > 0 )
{
MUTABLE_CPUPROFILER_SCOPE ( EndUpdate ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( MutableSystem ) ;
2022-09-26 15:12:13 -04:00
MutableSystem - > EndUpdate ( OperationData - > InstanceID ) ;
OperationData - > InstanceUpdateData . Clear ( ) ;
2023-01-10 15:48:59 -05:00
if ( ! OperationData - > bLiveUpdateMode )
{
MutableSystem - > ReleaseInstance ( OperationData - > InstanceID ) ;
OperationData - > InstanceID = 0 ;
}
}
2023-03-07 12:43:38 -05:00
2023-05-24 02:50:03 -04:00
if ( CVarClearWorkingMemoryOnUpdateEnd . GetValueOnAnyThread ( ) )
2023-03-07 12:43:38 -05:00
{
2023-05-24 02:50:03 -04:00
MutableSystem - > ClearWorkingMemory ( ) ;
2023-03-07 12:43:38 -05:00
}
2023-07-26 06:46:59 -04:00
UCustomizableObjectSystem : : GetInstance ( ) - > GetPrivate ( ) - > MutableTaskGraph . AllowLaunchingMutableTaskLowPriority ( true , true ) ;
2023-01-10 15:48:59 -05:00
}
void Task_Mutable_ReleaseInstanceID ( TSharedPtr < FMutableOperationData > OperationData , mu : : SystemPtr MutableSystem )
{
MUTABLE_CPUPROFILER_SCOPE ( Task_Mutable_ReleaseInstanceID )
// This runs in a worker thread.
check ( OperationData . IsValid ( ) ) ;
if ( OperationData - > InstanceID > 0 )
{
2022-09-26 15:12:13 -04:00
MutableSystem - > ReleaseInstance ( OperationData - > InstanceID ) ;
OperationData - > InstanceID = 0 ;
}
2023-03-07 12:43:38 -05:00
2023-05-24 02:50:03 -04:00
if ( CVarClearWorkingMemoryOnUpdateEnd . GetValueOnAnyThread ( ) )
2023-03-07 12:43:38 -05:00
{
2023-05-24 02:50:03 -04:00
MutableSystem - > ClearWorkingMemory ( ) ;
2023-03-07 12:43:38 -05:00
}
2022-09-26 15:12:13 -04:00
}
void Task_Game_ReleasePlatformData ( TSharedPtr < FMutableReleasePlatformOperationData > OperationData )
{
MUTABLE_CPUPROFILER_SCOPE ( Task_Game_ReleasePlatformData )
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( OperationData . IsValid ( ) ) ;
2022-09-26 15:12:13 -04:00
TMap < uint32 , FTexturePlatformData * > & ImageToPlatformDataMap = OperationData - > ImageToPlatformDataMap ;
for ( TPair < uint32 , FTexturePlatformData * > Pair : ImageToPlatformDataMap )
{
delete Pair . Value ; // If this is not null then it must mean it hasn't been used, otherwise they would have taken ownership and nulled it
}
ImageToPlatformDataMap . Reset ( ) ;
}
2022-10-10 07:09:51 -04:00
2022-09-26 15:12:13 -04:00
void Task_Game_Callbacks ( TSharedPtr < FMutableOperationData > OperationData , const TWeakObjectPtr < UCustomizableObjectInstance > & CustomizableObjectInstancePtr )
{
MUTABLE_CPUPROFILER_SCOPE ( Task_Game_Callbacks )
check ( IsInGameThread ( ) ) ;
UCustomizableObjectSystem * System = UCustomizableObjectSystem : : GetInstance ( ) ;
if ( ! System | | ! System - > IsValidLowLevel ( ) | | System - > HasAnyFlags ( RF_BeginDestroyed ) )
{
2023-07-28 06:06:02 -04:00
FinishUpdateGlobal ( CustomizableObjectInstancePtr . Get ( ) , EUpdateResult : : Error , & OperationData - > UpdateCallback ) ;
2022-09-26 15:12:13 -04:00
return ;
}
UCustomizableObjectInstance * CustomizableObjectInstance = CustomizableObjectInstancePtr . Get ( ) ;
// TODO: Review checks.
if ( ! CustomizableObjectInstance | | ! CustomizableObjectInstance - > IsValidLowLevel ( ) )
{
System - > ClearCurrentMutableOperation ( ) ;
2023-07-28 06:06:02 -04:00
FinishUpdateGlobal ( CustomizableObjectInstance , EUpdateResult : : Error , & OperationData - > UpdateCallback ) ;
2022-09-26 15:12:13 -04:00
return ;
}
2023-01-24 08:45:18 -05:00
FCustomizableObjectSystemPrivate * CustomizableObjectSystemPrivateData = System - > GetPrivate ( ) ;
check ( CustomizableObjectSystemPrivateData ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
// Actual work
2023-01-24 08:45:18 -05:00
// TODO MTBL-391: Review This hotfix
2023-07-28 06:06:02 -04:00
UpdateSkeletalMesh ( * CustomizableObjectInstance , CustomizableObjectSystemPrivateData - > CurrentMutableOperation - > InstanceDescriptorRuntimeHash , OperationData - > UpdateResult , & OperationData - > UpdateCallback ) ;
2022-09-26 15:12:13 -04:00
2023-07-18 09:36:44 -04:00
// All work is done, release unused textures.
if ( CustomizableObjectSystemPrivateData - > bReleaseTexturesImmediately )
{
FMutableResourceCache & Cache = CustomizableObjectSystemPrivateData - > GetObjectCache ( CustomizableObjectInstance - > GetCustomizableObject ( ) ) ;
UCustomizableInstancePrivateData * CustomizableObjectInstancePrivateData = CustomizableObjectInstance - > GetPrivate ( ) ;
for ( FGeneratedTexture & GeneratedTexture : CustomizableObjectInstancePrivateData - > TexturesToRelease )
{
UCustomizableInstancePrivateData : : ReleaseMutableTexture ( GeneratedTexture . Key , Cast < UTexture2D > ( GeneratedTexture . Texture ) , Cache ) ;
}
CustomizableObjectInstancePrivateData - > TexturesToRelease . Empty ( ) ;
}
2022-09-26 15:12:13 -04:00
// TODO: T2927
if ( LogBenchmarkUtil : : isLoggingActive ( ) )
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
double deltaSeconds = FPlatformTime : : Seconds ( ) - CustomizableObjectSystemPrivateData - > CurrentMutableOperation - > StartUpdateTime ;
2022-09-26 15:12:13 -04:00
int32 deltaMs = int32 ( deltaSeconds * 1000 ) ;
LogBenchmarkUtil : : updateStat ( " customizable_instance_build_time " , deltaMs ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
CustomizableObjectSystemPrivateData - > TotalBuildMs + = deltaMs ;
CustomizableObjectSystemPrivateData - > TotalBuiltInstances + + ;
2022-09-26 15:12:13 -04:00
SET_DWORD_STAT ( STAT_MutableInstanceBuildTime , deltaMs ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
SET_DWORD_STAT ( STAT_MutableInstanceBuildTimeAvrg , CustomizableObjectSystemPrivateData - > TotalBuildMs / CustomizableObjectSystemPrivateData - > TotalBuiltInstances ) ;
2022-09-26 15:12:13 -04:00
}
// End Update
System - > ClearCurrentMutableOperation ( ) ;
}
void Task_Game_ConvertResources ( TSharedPtr < FMutableOperationData > OperationData , const TWeakObjectPtr < UCustomizableObjectInstance > & CustomizableObjectInstancePtr )
{
MUTABLE_CPUPROFILER_SCOPE ( Task_Game_ConvertResources )
check ( IsInGameThread ( ) ) ;
UCustomizableObjectSystem * System = UCustomizableObjectSystem : : GetInstance ( ) ;
if ( ! System | | ! System - > IsValidLowLevel ( ) | | System - > HasAnyFlags ( RF_BeginDestroyed ) )
{
2023-07-28 06:06:02 -04:00
FinishUpdateGlobal ( CustomizableObjectInstancePtr . Get ( ) , EUpdateResult : : Error , & OperationData - > UpdateCallback ) ;
2022-09-26 15:12:13 -04:00
return ;
}
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( OperationData . IsValid ( ) ) ;
2022-09-26 15:12:13 -04:00
UCustomizableObjectInstance * CustomizableObjectInstance = CustomizableObjectInstancePtr . Get ( ) ;
// Actual work
2023-04-06 16:56:51 -04:00
// TODO: Review checks.
const bool bInstanceInvalid = ! CustomizableObjectInstance | | ! CustomizableObjectInstance - > IsValidLowLevel ( ) ;
if ( ! bInstanceInvalid )
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
UCustomizableInstancePrivateData * CustomizableInstancePrivateData = CustomizableObjectInstance - > GetPrivate ( ) ;
// Process the pending texture coverage queries
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
MUTABLE_CPUPROFILER_SCOPE ( GameTextureQueries ) ;
for ( const FPendingTextureCoverageQuery & Query : OperationData - > PendingTextureCoverageQueries )
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
UMaterialInterface * Material = nullptr ;
const uint32 * InstanceIndex = CustomizableInstancePrivateData - > ObjectToInstanceIndexMap . Find ( Query . MaterialIndex ) ;
if ( InstanceIndex & & CustomizableInstancePrivateData - > ReferencedMaterials . IsValidIndex ( * InstanceIndex ) )
{
Material = CustomizableInstancePrivateData - > ReferencedMaterials [ * InstanceIndex ] ;
}
UCustomizableInstancePrivateData : : ProcessTextureCoverageQueries ( OperationData , CustomizableObjectInstance - > GetCustomizableObject ( ) , Query . KeyName , Query . PlatformData , Material ) ;
2022-09-26 15:12:13 -04:00
}
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
OperationData - > PendingTextureCoverageQueries . Empty ( ) ;
2022-09-26 15:12:13 -04:00
}
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
// Process texture coverage queries because it's safe to do now that the Mutable thread is stopped
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
if ( OperationData - > TextureCoverageQueries_MutableThreadResults . Num ( ) > 0 )
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
for ( auto & Result : OperationData - > TextureCoverageQueries_MutableThreadResults )
{
FTextureCoverageQueryData * FinalResultData = CustomizableInstancePrivateData - > TextureCoverageQueries . Find ( Result . Key ) ;
* FinalResultData = Result . Value ;
}
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
OperationData - > TextureCoverageQueries_MutableThreadResults . Empty ( ) ;
}
2022-09-26 15:12:13 -04:00
# if WITH_EDITOR
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
CustomizableObjectInstance - > LastUpdateMutableRuntimeCycles = OperationData - > MutableRuntimeCycles ;
2022-09-26 15:12:13 -04:00
# endif
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
// Convert Step
//-------------------------------------------------------------
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
// \TODO: Bring that code here instead of keeping it in the UCustomizableObjectInstance
if ( CustomizableInstancePrivateData - > UpdateSkeletalMesh_PostBeginUpdate0 ( CustomizableObjectInstance , OperationData ) )
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
// This used to be CustomizableObjectInstance::UpdateSkeletalMesh_PostBeginUpdate1
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
MUTABLE_CPUPROFILER_SCOPE ( UpdateSkeletalMesh_PostBeginUpdate1 ) ;
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
// \TODO: Bring here
CustomizableInstancePrivateData - > BuildMaterials ( OperationData , CustomizableObjectInstance ) ;
}
// This used to be CustomizableObjectInstance::UpdateSkeletalMesh_PostBeginUpdate2
{
MUTABLE_CPUPROFILER_SCOPE ( UpdateSkeletalMesh_PostBeginUpdate2 ) ;
for ( int32 Component = 0 ; Component < CustomizableObjectInstance - > SkeletalMeshes . Num ( ) ; + + Component )
{
if ( CustomizableObjectInstance - > SkeletalMeshes [ Component ] & & CustomizableObjectInstance - > SkeletalMeshes [ Component ] - > GetLODInfoArray ( ) . Num ( ) )
{
MUTABLE_CPUPROFILER_SCOPE ( UpdateSkeletalMesh_PostEditChangeProperty ) ;
CustomizableInstancePrivateData - > PostEditChangePropertyWithoutEditor ( CustomizableObjectInstance - > SkeletalMeshes [ Component ] ) ;
}
2022-09-26 15:12:13 -04:00
}
}
}
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
} // END - Process texture coverage queries
2023-04-06 16:56:51 -04:00
} // if (!bInstanceValid)
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
FCustomizableObjectSystemPrivate * CustomizableObjectSystemPrivateData = System - > GetPrivate ( ) ;
check ( CustomizableObjectSystemPrivateData ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
// Next Task: Release Mutable. We need this regardless if we cancel or not
//-------------------------------------------------------------
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
mu : : SystemPtr MutableSystem = CustomizableObjectSystemPrivateData - > MutableSystem ;
2023-05-15 05:50:59 -04:00
CustomizableObjectSystemPrivateData - > MutableTaskGraph . AddMutableThreadTask (
2022-09-26 15:12:13 -04:00
TEXT ( " Task_Mutable_ReleaseInstance " ) ,
2023-05-15 05:50:59 -04:00
[ OperationData , MutableSystem ] ( ) { Task_Mutable_ReleaseInstance ( OperationData , MutableSystem ) ; } ) ;
2022-09-26 15:12:13 -04:00
}
// Next Task: Release Platform Data
//-------------------------------------------------------------
2023-04-06 16:56:51 -04:00
if ( ! bInstanceInvalid )
2022-09-26 15:12:13 -04:00
{
TSharedPtr < FMutableReleasePlatformOperationData > ReleaseOperationData = MakeShared < FMutableReleasePlatformOperationData > ( ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( ReleaseOperationData ) ;
2022-09-26 15:12:13 -04:00
ReleaseOperationData - > ImageToPlatformDataMap = MoveTemp ( OperationData - > ImageToPlatformDataMap ) ;
2023-05-15 05:50:59 -04:00
CustomizableObjectSystemPrivateData - > MutableTaskGraph . AddAnyThreadTask (
2022-09-26 15:12:13 -04:00
TEXT ( " Mutable_ReleasePlatformData " ) ,
2023-05-15 05:50:59 -04:00
[ ReleaseOperationData ] ( )
{
Task_Game_ReleasePlatformData ( ReleaseOperationData ) ;
}
2022-09-26 15:12:13 -04:00
) ;
// Unlock step
//-------------------------------------------------------------
if ( CustomizableObjectInstance - > GetCustomizableObject ( ) )
{
// Unlock the resource cache for the object used by this instance to avoid
// the destruction of resources that we may want to reuse.
System - > ClearResourceCacheProtected ( ) ;
}
// Next Task: Callbacks
//-------------------------------------------------------------
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
CustomizableObjectSystemPrivateData - > AddGameThreadTask (
2022-09-26 15:12:13 -04:00
{
FMutableTaskDelegate : : CreateLambda (
[ OperationData , CustomizableObjectInstancePtr ] ( )
{
Task_Game_Callbacks ( OperationData , CustomizableObjectInstancePtr ) ;
} ) ,
{ }
} ) ;
}
2023-04-06 16:56:51 -04:00
else
{
2023-07-28 06:06:02 -04:00
FinishUpdateGlobal ( CustomizableObjectInstance , EUpdateResult : : Error , & OperationData - > UpdateCallback ) ;
2023-04-06 16:56:51 -04:00
}
2022-09-26 15:12:13 -04:00
}
/** "Lock Cached Resources" */
2023-04-25 06:07:49 -04:00
void Task_Game_LockCache ( TSharedPtr < FMutableOperationData > OperationData , const TWeakObjectPtr < UCustomizableObjectInstance > & CustomizableObjectInstancePtr , mu : : Ptr < const mu : : Parameters > Parameters , bool bBuildParameterRelevancy )
2022-09-26 15:12:13 -04:00
{
2023-04-12 19:01:48 -04:00
MUTABLE_CPUPROFILER_SCOPE ( Task_Game_LockCache )
2023-03-23 08:20:51 -04:00
2022-09-26 15:12:13 -04:00
check ( IsInGameThread ( ) ) ;
2023-04-06 16:56:51 -04:00
check ( OperationData ) ;
2022-09-26 15:12:13 -04:00
UCustomizableObjectSystem * System = UCustomizableObjectSystem : : GetInstance ( ) ;
if ( ! System )
{
return ;
}
UCustomizableObjectInstance * ObjectInstance = CustomizableObjectInstancePtr . Get ( ) ;
if ( ! ObjectInstance )
{
System - > ClearCurrentMutableOperation ( ) ;
2023-07-28 06:06:02 -04:00
FinishUpdateGlobal ( ObjectInstance , EUpdateResult : : Error , & OperationData - > UpdateCallback ) ;
2022-09-26 15:12:13 -04:00
return ;
}
2023-01-10 15:48:59 -05:00
UCustomizableInstancePrivateData * ObjectInstancePrivateData = ObjectInstance - > GetPrivate ( ) ;
check ( ObjectInstancePrivateData ! = nullptr ) ;
if ( OperationData - > bLiveUpdateMode )
{
check ( OperationData - > InstanceID ! = 0 ) ;
if ( ObjectInstancePrivateData - > LiveUpdateModeInstanceID = = 0 )
{
// From now this instance will reuse this InstanceID until it gets out of LiveUpdateMode
ObjectInstancePrivateData - > LiveUpdateModeInstanceID = OperationData - > InstanceID ;
}
}
2022-09-26 15:12:13 -04:00
const UCustomizableObject * CustomizableObject = ObjectInstance - > GetCustomizableObject ( ) ;
if ( ! CustomizableObject )
{
System - > ClearCurrentMutableOperation ( ) ;
2023-07-28 06:06:02 -04:00
FinishUpdateGlobal ( CustomizableObjectInstancePtr . Get ( ) , EUpdateResult : : Error , & OperationData - > UpdateCallback ) ;
2022-09-26 15:12:13 -04:00
return ;
}
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( OperationData . IsValid ( ) ) ;
2022-09-26 15:12:13 -04:00
2023-04-25 06:07:49 -04:00
if ( bBuildParameterRelevancy )
2022-09-26 15:12:13 -04:00
{
2023-04-25 06:07:49 -04:00
// Relevancy
ObjectInstancePrivateData - > RelevantParameters = OperationData - > RelevantParametersInProgress ;
2022-09-26 15:12:13 -04:00
}
2023-01-25 13:01:06 -05:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
// Selectively lock the resource cache for the object used by this instance to avoid the destruction of resources that we may want to reuse.
2022-09-26 15:12:13 -04:00
// When protecting textures there mustn't be any left from a previous update
check ( System - > ProtectedCachedTextures . Num ( ) = = 0 ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
FCustomizableObjectSystemPrivate * SystemPrivateData = System - > GetPrivate ( ) ;
check ( SystemPrivateData ! = nullptr ) ;
2023-04-05 11:20:44 -04:00
// TODO: If this is the first code that runs after the CO program has finished AND if it's
// guaranteed that the next CO program hasn't started yet, we need to call ClearActiveObject
// and CancelPendingLoads on SystemPrivateData->ExtensionDataStreamer.
//
// ExtensionDataStreamer->AreAnyLoadsPending should return false if the program succeeded.
//
// If the program aborted, AreAnyLoadsPending may return true, as the program doesn't cancel
// its own loads on exit (maybe it should?)
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
FMutableResourceCache & Cache = SystemPrivateData - > GetObjectCache ( CustomizableObject ) ;
2022-09-26 15:12:13 -04:00
System - > ProtectedCachedTextures . Reset ( Cache . Images . Num ( ) ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
SystemPrivateData - > ProtectedObjectCachedImages . Reset ( Cache . Images . Num ( ) ) ;
2022-09-26 15:12:13 -04:00
for ( const FInstanceUpdateData : : FImage & Image : OperationData - > InstanceUpdateData . Images )
{
2022-10-21 19:53:30 -04:00
FMutableImageCacheKey Key ( Image . ImageID , OperationData - > MipsToSkip ) ;
TWeakObjectPtr < UTexture2D > * TexturePtr = Cache . Images . Find ( Key ) ;
2022-09-26 15:12:13 -04:00
2023-07-18 09:36:44 -04:00
if ( TexturePtr & & TexturePtr - > Get ( ) & & SystemPrivateData - > TextureHasReferences ( Key ) )
2022-09-26 15:12:13 -04:00
{
System - > ProtectedCachedTextures . Add ( TexturePtr - > Get ( ) ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
SystemPrivateData - > ProtectedObjectCachedImages . Add ( Image . ImageID ) ;
2022-09-26 15:12:13 -04:00
}
}
2022-10-04 09:10:32 -04:00
// Any external texture that may be needed for this update will be requested from Mutable Core's GetImage
// which will safely access the GlobalExternalImages map, and then just get the cached image or issue a disk read
2022-09-26 15:12:13 -04:00
// Copy data generated in the mutable thread over to the instance
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
ObjectInstancePrivateData - > PrepareForUpdate ( OperationData ) ;
2022-09-26 15:12:13 -04:00
// Task: Mutable GetImages
//-------------------------------------------------------------
2023-02-08 04:20:33 -05:00
# ifdef MUTABLE_USE_NEW_TASKGRAPH
UE : : Tasks : : FTask Mutable_GetImagesTask ;
# else
2022-09-26 15:12:13 -04:00
FGraphEventRef Mutable_GetImagesTask ;
2023-02-08 04:20:33 -05:00
# endif
2022-09-26 15:12:13 -04:00
{
// Task inputs
2022-12-09 03:57:57 -05:00
TSharedPtr < mu : : Model , ESPMode : : ThreadSafe > Model = CustomizableObject - > GetPrivate ( ) - > GetModel ( ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
int32 State = ObjectInstance - > GetState ( ) ;
2022-09-26 15:12:13 -04:00
2023-05-15 05:50:59 -04:00
Mutable_GetImagesTask = SystemPrivateData - > MutableTaskGraph . AddMutableThreadTask (
2022-09-26 15:12:13 -04:00
TEXT ( " Task_Mutable_GetImages " ) ,
[ OperationData , Parameters , Model , State ] ( )
{
impl : : Task_Mutable_Update_GetImages ( OperationData , Model , Parameters , State ) ;
2023-05-15 05:50:59 -04:00
} ) ;
2022-09-26 15:12:13 -04:00
}
// Next Task: Load Unreal Assets
//-------------------------------------------------------------
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
FGraphEventRef Game_LoadUnrealAssets = ObjectInstancePrivateData - > LoadAdditionalAssetsAsync ( OperationData , ObjectInstance , UCustomizableObjectSystem : : GetInstance ( ) - > GetStreamableManager ( ) ) ;
if ( Game_LoadUnrealAssets )
{
Game_LoadUnrealAssets - > SetDebugName ( TEXT ( " LoadAdditionalAssetsAsync " ) ) ;
}
2022-09-26 15:12:13 -04:00
// Next-next Task: Convert Resources
//-------------------------------------------------------------
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
SystemPrivateData - > AddGameThreadTask (
2022-09-26 15:12:13 -04:00
{
FMutableTaskDelegate : : CreateLambda (
[ OperationData , CustomizableObjectInstancePtr ] ( )
{
Task_Game_ConvertResources ( OperationData , CustomizableObjectInstancePtr ) ;
} ) ,
# ifdef MUTABLE_USE_NEW_TASKGRAPH
{ } ,
# endif
Game_LoadUnrealAssets ,
Mutable_GetImagesTask
} ) ;
}
2023-01-10 15:48:59 -05:00
/** Enqueue the release ID operation in the Mutable queue */
void Task_Game_ReleaseInstanceID ( const mu : : Instance : : ID IDToRelease )
{
2023-03-23 08:20:51 -04:00
MUTABLE_CPUPROFILER_SCOPE ( Task_Game_ReleaseInstanceID )
2023-01-10 15:48:59 -05:00
UCustomizableObjectSystem * System = UCustomizableObjectSystem : : GetInstance ( ) ;
check ( System ! = nullptr ) ;
FCustomizableObjectSystemPrivate * SystemPrivateData = System - > GetPrivate ( ) ;
check ( SystemPrivateData ! = nullptr ) ;
mu : : SystemPtr MutableSystem = SystemPrivateData - > MutableSystem ;
// Task: Release Instance ID
//-------------------------------------------------------------
TSharedPtr < FMutableOperationData > CurrentOperationData = MakeShared < FMutableOperationData > ( ) ;
check ( CurrentOperationData ) ;
CurrentOperationData - > InstanceID = IDToRelease ;
2023-02-08 04:20:33 -05:00
# ifdef MUTABLE_USE_NEW_TASKGRAPH
UE : : Tasks : : FTask Mutable_GetMeshTask ;
# else
2023-01-10 15:48:59 -05:00
FGraphEventRef Mutable_GetMeshTask ;
2023-02-08 04:20:33 -05:00
# endif
2023-01-10 15:48:59 -05:00
{
// Task inputs
TSharedPtr < FMutableOperation > CurrentMutableOperation = SystemPrivateData - > CurrentMutableOperation ;
check ( CurrentMutableOperation ) ;
2023-05-15 05:50:59 -04:00
Mutable_GetMeshTask = SystemPrivateData - > MutableTaskGraph . AddMutableThreadTask (
2023-01-10 15:48:59 -05:00
TEXT ( " Task_Mutable_ReleaseInstanceID " ) ,
[ CurrentOperationData , MutableSystem ] ( )
{
impl : : Task_Mutable_ReleaseInstanceID ( CurrentOperationData , MutableSystem ) ;
2023-05-15 05:50:59 -04:00
} ) ;
2023-01-10 15:48:59 -05:00
}
}
2022-09-26 15:12:13 -04:00
/** "Start Update" */
void Task_Game_StartUpdate ( TSharedPtr < FMutableOperation > Operation )
{
2023-03-23 08:20:51 -04:00
MUTABLE_CPUPROFILER_SCOPE ( Task_Game_StartUpdate )
2023-05-15 05:50:59 -04:00
UCustomizableObjectSystem : : GetInstance ( ) - > GetPrivate ( ) - > MutableTaskGraph . AllowLaunchingMutableTaskLowPriority ( false , false ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Operation ) ;
2022-09-26 15:12:13 -04:00
UCustomizableObjectSystem * System = UCustomizableObjectSystem : : GetInstance ( ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( System ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
if ( ! Operation - > CustomizableObjectInstance . IsValid ( ) | | ! Operation - > CustomizableObjectInstance - > IsValidLowLevel ( ) ) // Only start if it hasn't been already destroyed (i.e. GC after finish PIE)
{
System - > ClearCurrentMutableOperation ( ) ;
2023-07-28 06:06:02 -04:00
FinishUpdateGlobal ( nullptr , EUpdateResult : : Error , & Operation - > UpdateCallback ) ;
2022-09-26 15:12:13 -04:00
return ;
}
2023-01-24 08:45:18 -05:00
TObjectPtr < UCustomizableObjectInstance > CandidateInstance = Operation - > CustomizableObjectInstance . Get ( ) ;
UCustomizableInstancePrivateData * CandidateInstancePrivateData = CandidateInstance - > GetPrivate ( ) ;
2023-03-06 13:06:53 -05:00
if ( ! CandidateInstancePrivateData )
{
System - > ClearCurrentMutableOperation ( ) ;
2023-07-28 06:06:02 -04:00
FinishUpdateGlobal ( nullptr , EUpdateResult : : Error , & Operation - > UpdateCallback ) ;
2023-03-06 13:06:53 -05:00
return ;
}
2023-04-06 16:56:51 -04:00
if ( CandidateInstancePrivateData - > HasCOInstanceFlags ( PendingLODsUpdate ) )
2022-09-26 15:12:13 -04:00
{
2023-01-24 08:45:18 -05:00
CandidateInstancePrivateData - > ClearCOInstanceFlags ( PendingLODsUpdate ) ;
2022-09-26 15:12:13 -04:00
// TODO: Is anything needed for this now?
//Operation->CustomizableObjectInstance->ReleaseMutableInstanceId(); // To make mutable regenerate the LODs even if the instance parameters have not changed
}
bool bCancel = false ;
// If the object is locked (for instance, compiling) we skip any instance update.
2023-01-24 08:45:18 -05:00
TObjectPtr < UCustomizableObject > CustomizableObject = CandidateInstance - > GetCustomizableObject ( ) ;
if ( ! CustomizableObject )
2022-09-26 15:12:13 -04:00
{
bCancel = true ;
}
2022-09-27 08:28:56 -04:00
else
{
2023-01-24 08:45:18 -05:00
if ( CustomizableObject - > GetPrivate ( ) - > bLocked )
2022-09-27 08:28:56 -04:00
{
bCancel = true ;
}
2022-09-26 15:12:13 -04:00
}
2023-01-24 08:45:18 -05:00
// Only update resources if the instance is in range (it could have got far from the player since the task was queued)
check ( System - > CurrentInstanceLODManagement ! = nullptr ) ;
if ( System - > CurrentInstanceLODManagement - > IsOnlyUpdateCloseCustomizableObjectsEnabled ( )
2023-01-27 14:45:45 -05:00
& & CandidateInstancePrivateData
2023-01-24 08:45:18 -05:00
& & CandidateInstancePrivateData - > LastMinSquareDistFromComponentToPlayer > FMath : : Square ( System - > CurrentInstanceLODManagement - > GetOnlyUpdateCloseCustomizableObjectsDist ( ) )
& & CandidateInstancePrivateData - > LastMinSquareDistFromComponentToPlayer ! = FLT_MAX // This means it is the first frame so it has to be updated
)
{
bCancel = true ;
}
// Skip update, the requested update is equal to the running update.
if ( Operation - > InstanceDescriptorRuntimeHash . IsSubset ( CandidateInstance - > GetDescriptorRuntimeHash ( ) ) )
{
2023-03-06 07:19:46 -05:00
CandidateInstance - > SkeletalMeshStatus = ESkeletalMeshState : : Correct ;
2023-07-28 06:06:02 -04:00
UpdateSkeletalMesh ( * CandidateInstance , CandidateInstance - > GetDescriptorRuntimeHash ( ) , EUpdateResult : : Success , & Operation - > UpdateCallback ) ;
2023-01-24 08:45:18 -05:00
bCancel = true ;
}
mu : : Ptr < const mu : : Parameters > Parameters = Operation - > GetParameters ( ) ;
if ( ! Parameters )
{
bCancel = true ;
}
2022-09-26 15:12:13 -04:00
if ( bCancel )
{
2023-03-06 13:06:53 -05:00
CandidateInstancePrivateData - > ClearCOInstanceFlags ( Updating ) ;
2023-01-24 08:45:18 -05:00
2022-09-26 15:12:13 -04:00
System - > ClearCurrentMutableOperation ( ) ;
2023-04-06 16:56:51 -04:00
2023-07-28 06:06:02 -04:00
FinishUpdateGlobal ( CandidateInstance , EUpdateResult : : Error , & Operation - > UpdateCallback ) ;
2022-09-26 15:12:13 -04:00
return ;
}
if ( LogBenchmarkUtil : : isLoggingActive ( ) )
{
Operation - > StartUpdateTime = FPlatformTime : : Seconds ( ) ;
}
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
FCustomizableObjectSystemPrivate * SystemPrivateData = System - > GetPrivate ( ) ;
check ( SystemPrivateData ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
SystemPrivateData - > CurrentInstanceBeingUpdated = CandidateInstance ;
2022-09-26 15:12:13 -04:00
// Prepare streaming for the current customizable object
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( SystemPrivateData - > Streamer ! = nullptr ) ;
SystemPrivateData - > Streamer - > PrepareStreamingForObject ( CustomizableObject ) ;
2022-09-26 15:12:13 -04:00
2023-04-05 11:20:44 -04:00
check ( SystemPrivateData - > ExtensionDataStreamer ! = nullptr ) ;
SystemPrivateData - > ExtensionDataStreamer - > SetActiveObject ( CustomizableObject ) ;
2022-11-28 07:21:35 -05:00
CandidateInstance - > CommitMinMaxLOD ( ) ;
2023-01-10 15:48:59 -05:00
2023-01-19 10:44:15 -05:00
FString StateName = CandidateInstance - > GetCustomizableObject ( ) - > GetStateName ( CandidateInstance - > GetState ( ) ) ;
const FParameterUIData * StateData = CandidateInstance - > GetCustomizableObject ( ) - > StateUIDataMap . Find ( StateName ) ;
2023-01-11 14:44:41 -05:00
bool bLiveUpdateMode = false ;
if ( SystemPrivateData - > EnableMutableLiveUpdate )
{
bLiveUpdateMode = StateData ? StateData - > bLiveUpdateMode : false ;
}
2023-01-10 15:48:59 -05:00
if ( bLiveUpdateMode & & ( ! Operation - > bNeverStream | | Operation - > MipsToSkip > 0 ) )
{
UE_LOG ( LogMutable , Warning , TEXT ( " Instance LiveUpdateMode does not yet support progressive streaming of Mutable textures. Disabling LiveUpdateMode for this update. " ) ) ;
bLiveUpdateMode = false ;
}
2023-01-19 10:44:15 -05:00
bool bReuseInstanceTextures = false ;
if ( SystemPrivateData - > EnableReuseInstanceTextures )
{
2023-03-10 05:20:20 -05:00
bReuseInstanceTextures = StateData ? StateData - > bReuseInstanceTextures : false ;
bReuseInstanceTextures | = CandidateInstancePrivateData - > HasCOInstanceFlags ( ReuseTextures ) ;
if ( bReuseInstanceTextures & & ! Operation - > bNeverStream )
2023-01-19 10:44:15 -05:00
{
UE_LOG ( LogMutable , Warning , TEXT ( " Instance texture reuse requires that the current Mutable state is in non-streaming mode. Change it in the Mutable graph base node in the state definition. " ) ) ;
bReuseInstanceTextures = false ;
}
}
2023-01-10 15:48:59 -05:00
if ( ! bLiveUpdateMode & & CandidateInstancePrivateData - > LiveUpdateModeInstanceID ! = 0 )
{
// The instance was in live update mode last update, but now it's not. So the Id and resources have to be released.
// Enqueue a new mutable task to release them
Task_Game_ReleaseInstanceID ( CandidateInstancePrivateData - > LiveUpdateModeInstanceID ) ;
CandidateInstancePrivateData - > LiveUpdateModeInstanceID = 0 ;
}
2022-11-28 07:21:35 -05:00
2022-09-26 15:12:13 -04:00
// Task: Mutable Update and GetMesh
//-------------------------------------------------------------
TSharedPtr < FMutableOperationData > CurrentOperationData = MakeShared < FMutableOperationData > ( ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( CurrentOperationData ) ;
CurrentOperationData - > TextureCoverageQueries_MutableThreadParams = CandidateInstancePrivateData - > TextureCoverageQueries ;
2022-09-26 15:12:13 -04:00
CurrentOperationData - > TextureCoverageQueries_MutableThreadResults . Empty ( ) ;
2023-01-24 08:45:18 -05:00
CurrentOperationData - > bCanReuseGeneratedData = SystemPrivateData - > bEnableMutableReusePreviousUpdateData ;
CurrentOperationData - > LastUpdateData = SystemPrivateData - > bEnableMutableReusePreviousUpdateData ? CandidateInstancePrivateData - > LastUpdateData : FInstanceGeneratedData ( ) ;
2022-11-28 07:21:35 -05:00
CurrentOperationData - > CurrentMinLOD = Operation - > InstanceDescriptorRuntimeHash . GetMinLOD ( ) ;
CurrentOperationData - > CurrentMaxLOD = Operation - > InstanceDescriptorRuntimeHash . GetMaxLOD ( ) ;
2022-09-26 15:12:13 -04:00
CurrentOperationData - > bNeverStream = Operation - > bNeverStream ;
2023-01-10 15:48:59 -05:00
CurrentOperationData - > bLiveUpdateMode = bLiveUpdateMode ;
2023-01-19 10:44:15 -05:00
CurrentOperationData - > bReuseInstanceTextures = bReuseInstanceTextures ;
2023-01-10 15:48:59 -05:00
CurrentOperationData - > InstanceID = bLiveUpdateMode ? CandidateInstancePrivateData - > LiveUpdateModeInstanceID : 0 ;
2022-09-26 15:12:13 -04:00
CurrentOperationData - > MipsToSkip = Operation - > MipsToSkip ;
CurrentOperationData - > MutableParameters = Parameters ;
2023-01-24 08:45:18 -05:00
CurrentOperationData - > State = CandidateInstance - > GetState ( ) ;
2023-04-06 16:56:51 -04:00
CurrentOperationData - > UpdateResult = EUpdateResult : : Success ;
CurrentOperationData - > UpdateCallback = Operation - > UpdateCallback ;
2023-02-02 02:41:54 -05:00
CustomizableObject - > GetLowPriorityTextureNames ( CurrentOperationData - > LowPriorityTextures ) ;
2023-01-24 08:45:18 -05:00
2023-06-22 06:24:44 -04:00
if ( System - > IsOnlyGenerateRequestedLODsEnabled ( ) & & System - > CurrentInstanceLODManagement - > IsOnlyGenerateRequestedLODLevelsEnabled ( ) & &
! Operation - > bForceGenerateAllLODs )
2023-01-24 08:45:18 -05:00
{
CurrentOperationData - > RequestedLODs = Operation - > InstanceDescriptorRuntimeHash . GetRequestedLODs ( ) ;
}
2022-09-26 15:12:13 -04:00
2023-02-08 04:20:33 -05:00
# ifdef MUTABLE_USE_NEW_TASKGRAPH
UE : : Tasks : : FTask Mutable_GetMeshTask ;
# else
2022-09-26 15:12:13 -04:00
FGraphEventRef Mutable_GetMeshTask ;
2023-02-08 04:20:33 -05:00
# endif
2022-09-26 15:12:13 -04:00
{
// Task inputs
TWeakObjectPtr < UCustomizableObjectInstance > CustomizableObjectInstancePtr = CandidateInstance ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( CustomizableObjectInstancePtr . IsValid ( ) ) ;
TSharedPtr < FMutableOperation > CurrentMutableOperation = SystemPrivateData - > CurrentMutableOperation ;
check ( CurrentMutableOperation ) ;
2023-04-25 06:07:49 -04:00
bool bBuildParameterRelevancy = CurrentMutableOperation - > IsBuildParameterRelevancy ( ) ;
2022-12-09 03:57:57 -05:00
TSharedPtr < mu : : Model , ESPMode : : ThreadSafe > Model = CustomizableObject - > GetPrivate ( ) - > GetModel ( ) ;
2022-09-26 15:12:13 -04:00
int32 State = CustomizableObjectInstancePtr - > GetState ( ) ;
2023-05-15 05:50:59 -04:00
Mutable_GetMeshTask = SystemPrivateData - > MutableTaskGraph . AddMutableThreadTask (
2022-09-26 15:12:13 -04:00
TEXT ( " Task_Mutable_Update_GetMesh " ) ,
2023-04-25 06:07:49 -04:00
[ CurrentOperationData , bBuildParameterRelevancy , Parameters , Model , State ] ( )
2022-09-26 15:12:13 -04:00
{
2023-04-25 06:07:49 -04:00
impl : : Task_Mutable_Update_GetMesh ( CurrentOperationData , Model , Parameters , bBuildParameterRelevancy , State ) ;
2023-05-15 05:50:59 -04:00
} ) ;
2022-09-26 15:12:13 -04:00
}
// Task: Lock cache
//-------------------------------------------------------------
{
// Task inputs
TWeakObjectPtr < UCustomizableObjectInstance > CustomizableObjectInstancePtr = CandidateInstance ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( CustomizableObjectInstancePtr . IsValid ( ) ) ;
TSharedPtr < FMutableOperation > CurrentMutableOperation = SystemPrivateData - > CurrentMutableOperation ;
check ( CurrentMutableOperation ) ;
2023-04-25 06:07:49 -04:00
bool bBuildParameterRelevancy = CurrentMutableOperation - > IsBuildParameterRelevancy ( ) ;
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
SystemPrivateData - > AddGameThreadTask (
2022-09-26 15:12:13 -04:00
{
FMutableTaskDelegate : : CreateLambda (
2023-04-25 06:07:49 -04:00
[ CurrentOperationData , CustomizableObjectInstancePtr , bBuildParameterRelevancy , Parameters ] ( )
2022-09-26 15:12:13 -04:00
{
2023-04-25 06:07:49 -04:00
impl : : Task_Game_LockCache ( CurrentOperationData , CustomizableObjectInstancePtr , Parameters , bBuildParameterRelevancy ) ;
2022-09-26 15:12:13 -04:00
} ) ,
Mutable_GetMeshTask
} ) ;
}
}
} // namespace impl
void UCustomizableObjectSystem : : AdvanceCurrentOperation ( )
{
2022-12-01 06:49:41 -05:00
MUTABLE_CPUPROFILER_SCOPE ( AdvanceCurrentOperation ) ;
2022-09-26 15:12:13 -04:00
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
// See if we have a game-thread task to process
FMutableTask * PendingTask = Private - > PendingTasks . Peek ( ) ;
if ( PendingTask )
{
if ( PendingTask - > AreDependenciesComplete ( ) )
{
PendingTask - > ClearDependencies ( ) ;
PendingTask - > Function . Execute ( ) ;
Private - > PendingTasks . Pop ( ) ;
}
// Don't do anything else until the pending work is completed.
return ;
}
// It is safe to do this now.
2023-05-24 02:50:03 -04:00
Private - > UpdateMemoryLimit ( ) ;
2022-09-26 15:12:13 -04:00
// If we don't have an ongoing operation, don't do anything.
if ( ! Private - > CurrentMutableOperation . IsValid ( ) )
{
return ;
}
// If we reach here it means:
// - we have an ongoing operations
// - we have no pending work for the ongoing operation
// - so we are starting it.
{
2023-06-22 06:24:44 -04:00
MUTABLE_CPUPROFILER_SCOPE ( OperationUpdate ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
2023-06-22 06:24:44 -04:00
// Start the first task of the update process. See namespace impl comments above.
impl : : Task_Game_StartUpdate ( Private - > CurrentMutableOperation ) ;
2022-09-26 15:12:13 -04:00
}
}
bool UCustomizableObjectSystem : : Tick ( float DeltaTime )
{
MUTABLE_CPUPROFILER_SCOPE ( UCustomizableObjectSystem : : Tick )
2023-06-22 06:24:44 -04:00
// Building instances is not enabled in servers. If at some point relevant collision or animation data is necessary for server logic this will need to be changed.
2022-09-26 15:12:13 -04:00
# if UE_SERVER
return true ;
# endif
if ( ! Private . IsValid ( ) )
{
return true ;
}
UWorld * World = GWorld ;
if ( World )
{
EWorldType : : Type WorldType = World - > WorldType ;
if ( WorldType ! = EWorldType : : PIE & & WorldType ! = EWorldType : : Game & & WorldType ! = EWorldType : : Editor & & WorldType ! = EWorldType : : GamePreview )
{
return true ;
}
}
// \TODO: Review: We should never compile an object from this tick, so this could be removed
# if WITH_EDITOR
FAssetRegistryModule & AssetRegistryModule = FModuleManager : : LoadModuleChecked < FAssetRegistryModule > ( " AssetRegistry " ) ;
if ( AssetRegistryModule . Get ( ) . IsLoadingAssets ( ) )
{
return true ; // Assets are still being loaded, so subobjects won't be found, compiled objects incomplete and thus updates wrong
}
2023-07-20 07:38:13 -04:00
// Do not tick if the CookCommandlet is running.
if ( IsRunningCookCommandlet ( ) )
{
return true ;
}
2022-09-26 15:12:13 -04:00
# endif
2023-05-15 05:50:59 -04:00
2022-09-26 15:12:13 -04:00
// Get a new operation if we aren't working on one
if ( ! Private - > CurrentMutableOperation )
{
2023-01-24 08:45:18 -05:00
// Reset the instance relevancy
2023-06-22 06:24:44 -04:00
// The RequestedUpdates only refer to LOD changes. User Customization and discards are handled separately
FMutableInstanceUpdateMap RequestedLODUpdates ;
CurrentInstanceLODManagement - > UpdateInstanceDistsAndLODs ( RequestedLODUpdates ) ;
2023-01-24 08:45:18 -05:00
for ( TObjectIterator < UCustomizableObjectInstance > CustomizableObjectInstance ; CustomizableObjectInstance ; + + CustomizableObjectInstance )
{
if ( IsValidChecked ( * CustomizableObjectInstance ) & & CustomizableObjectInstance - > GetPrivate ( ) )
{
UCustomizableInstancePrivateData * ObjectInstancePrivateData = CustomizableObjectInstance - > GetPrivate ( ) ;
if ( ObjectInstancePrivateData - > HasCOInstanceFlags ( UsedByComponentInPlay ) )
{
2023-07-21 03:28:52 -04:00
ObjectInstancePrivateData - > TickUpdateCloseCustomizableObjects ( * * CustomizableObjectInstance , RequestedLODUpdates ) ;
2023-01-24 08:45:18 -05:00
}
else if ( ObjectInstancePrivateData - > HasCOInstanceFlags ( UsedByComponent ) )
{
2023-06-22 06:24:44 -04:00
ensure ( ! RequestedLODUpdates . Contains ( * CustomizableObjectInstance ) ) ;
ObjectInstancePrivateData - > UpdateInstanceIfNotGenerated ( * * CustomizableObjectInstance , RequestedLODUpdates ) ;
}
else
{
ensure ( ! RequestedLODUpdates . Contains ( * CustomizableObjectInstance ) ) ;
2023-01-24 08:45:18 -05:00
}
ObjectInstancePrivateData - > ClearCOInstanceFlags ( ( ECOInstanceFlags ) ( UsedByComponent | UsedByComponentInPlay | PendingLODsUpdate ) ) ; // TODO MTBL-391: Makes no sense to clear it here, what if an update is requested before we set it back to true
}
2023-06-22 06:24:44 -04:00
else
{
ensure ( ! RequestedLODUpdates . Contains ( * CustomizableObjectInstance ) ) ;
}
2023-01-24 08:45:18 -05:00
}
2023-06-22 06:24:44 -04:00
TSharedPtr < FMutableOperation > FoundOperation ;
2023-01-24 08:45:18 -05:00
2023-06-22 06:24:44 -04:00
{
// Look for the highest priority update between the pending updates and the LOD Requested Updates
EQueuePriorityType MaxPriorityFound = EQueuePriorityType : : Low ;
double MaxSquareDistanceFound = TNumericLimits < double > : : Max ( ) ;
double MinTimeFound = TNumericLimits < double > : : Max ( ) ;
const FMutablePendingInstanceUpdate * PendingInstanceUpdateFound = nullptr ;
FMutableUpdateCandidate * LODUpdateCandidateFound = nullptr ;
// Look for the highest priority Pending Update
for ( auto Iterator = Private - > MutablePendingInstanceWork . GetUpdateIterator ( ) ; Iterator ; + + Iterator )
{
FMutablePendingInstanceUpdate & PendingUpdate = * Iterator ;
if ( PendingUpdate . CustomizableObjectInstance . IsValid ( ) )
{
EQueuePriorityType PriorityType = PendingUpdate . CustomizableObjectInstance - > GetUpdatePriority ( true , true , false , false ) ;
if ( PendingUpdate . PriorityType < = MaxPriorityFound )
{
const double MinSquareDistFromComponentToPlayer = PendingUpdate . CustomizableObjectInstance - > GetPrivate ( ) - > MinSquareDistFromComponentToPlayer ;
if ( MinSquareDistFromComponentToPlayer < MaxSquareDistanceFound | |
( MinSquareDistFromComponentToPlayer = = MaxSquareDistanceFound & & PendingUpdate . SecondsAtUpdate < MinTimeFound ) )
{
MaxPriorityFound = PriorityType ;
MaxSquareDistanceFound = MinSquareDistFromComponentToPlayer ;
MinTimeFound = PendingUpdate . SecondsAtUpdate ;
PendingInstanceUpdateFound = & PendingUpdate ;
LODUpdateCandidateFound = nullptr ;
}
}
}
else
{
Iterator . RemoveCurrent ( ) ;
}
}
// Look for a higher priority LOD update
for ( TPair < const UCustomizableObjectInstance * , FMutableUpdateCandidate > & LODUpdateTuple : RequestedLODUpdates )
{
const UCustomizableObjectInstance * Instance = LODUpdateTuple . Key ;
if ( Instance )
{
FMutableUpdateCandidate & LODUpdateCandidate = LODUpdateTuple . Value ;
ensure ( LODUpdateCandidate . HasBeenIssued ( ) ) ;
if ( LODUpdateCandidate . Priority < = MaxPriorityFound )
{
if ( LODUpdateCandidate . CustomizableObjectInstance - > GetPrivate ( ) - > MinSquareDistFromComponentToPlayer < MaxSquareDistanceFound )
{
MaxPriorityFound = LODUpdateCandidate . Priority ;
MaxSquareDistanceFound = LODUpdateCandidate . CustomizableObjectInstance - > GetPrivate ( ) - > MinSquareDistFromComponentToPlayer ;
PendingInstanceUpdateFound = nullptr ;
LODUpdateCandidateFound = & LODUpdateCandidate ;
}
}
}
}
Private - > MutablePendingInstanceWork . SetLODUpdatesLastTick ( RequestedLODUpdates . Num ( ) ) ;
// If the chosen LODUpdate has the same instance as a PendingUpdate, choose the PendingUpdate to apply both the LOD update
// and customization change
if ( LODUpdateCandidateFound )
{
if ( const FMutablePendingInstanceUpdate * PendingUpdateWithSameInstance = Private - > MutablePendingInstanceWork . GetUpdate ( LODUpdateCandidateFound - > CustomizableObjectInstance ) )
{
PendingInstanceUpdateFound = PendingUpdateWithSameInstance ;
LODUpdateCandidateFound = nullptr ;
// In the processing of the PendingUpdate just below, it will add the LODUpdate's LOD params
}
}
if ( PendingInstanceUpdateFound )
{
check ( ! LODUpdateCandidateFound ) ;
UCustomizableObjectInstance * PendingInstance = PendingInstanceUpdateFound - > CustomizableObjectInstance . Get ( ) ;
ensure ( PendingInstance ) ;
// Maybe there's a LODUpdate that has the same instance, merge both updates as an optimization
FMutableUpdateCandidate * LODUpdateWithSameInstance = RequestedLODUpdates . Find ( PendingInstance ) ;
if ( LODUpdateWithSameInstance )
{
LODUpdateWithSameInstance - > ApplyLODUpdateParamsToInstance ( ) ;
}
// No need to do a DoUpdateSkeletalMesh, as it was already done when adding the pending update
FoundOperation = MakeShared < FMutableOperation > ( FMutableOperation : : CreateInstanceUpdate ( PendingInstance ,
PendingInstanceUpdateFound - > bNeverStream , PendingInstanceUpdateFound - > MipsToSkip , PendingInstanceUpdateFound - > Callback ) ) ;
Private - > MutablePendingInstanceWork . RemoveUpdate ( PendingInstanceUpdateFound - > CustomizableObjectInstance ) ;
}
else if ( LODUpdateCandidateFound )
{
// Commit the LOD changes
LODUpdateCandidateFound - > ApplyLODUpdateParamsToInstance ( ) ;
// No need to check if a PendingUpdate has the same instance, it would already have been caught in the
// previous if statements
// LOD updates are detected automatically and have never had a DoUpdateSkeletalMesh, so call it without enqueing a new update
2023-07-21 03:28:52 -04:00
const EUpdateRequired Required = EUpdateRequired : : Update ;
LODUpdateCandidateFound - > CustomizableObjectInstance - > DoUpdateSkeletalMesh ( true , false , false , false , & Required , nullptr ) ;
2023-06-22 06:24:44 -04:00
bool bNeverStream = false ;
int32 MipsToSkip = 0 ;
ensure ( LODUpdateCandidateFound - > CustomizableObjectInstance ) ;
GetPrivate ( ) - > GetMipStreamingConfig ( * LODUpdateCandidateFound - > CustomizableObjectInstance , bNeverStream , MipsToSkip ) ;
FoundOperation = MakeShared < FMutableOperation > ( FMutableOperation : : CreateInstanceUpdate ( LODUpdateCandidateFound - > CustomizableObjectInstance ,
bNeverStream , MipsToSkip , nullptr ) ) ;
}
}
{
2023-01-24 08:45:18 -05:00
for ( TObjectIterator < UCustomizableObjectInstance > CustomizableObjectInstance ; CustomizableObjectInstance ; + + CustomizableObjectInstance )
{
if ( IsValidChecked ( * CustomizableObjectInstance ) & & CustomizableObjectInstance - > GetPrivate ( ) )
{
CustomizableObjectInstance - > GetPrivate ( ) - > LastMinSquareDistFromComponentToPlayer = CustomizableObjectInstance - > GetPrivate ( ) - > MinSquareDistFromComponentToPlayer ;
CustomizableObjectInstance - > GetPrivate ( ) - > MinSquareDistFromComponentToPlayer = FLT_MAX ;
}
}
}
2022-09-26 15:12:13 -04:00
// Update the streaming limit if it has changed. It is safe to do this now.
2023-05-24 02:50:03 -04:00
Private - > UpdateMemoryLimit ( ) ;
2022-09-26 15:12:13 -04:00
2023-06-22 06:24:44 -04:00
// Free memory before starting the new update
DiscardInstances ( ) ;
ReleaseInstanceIDs ( ) ;
2022-09-26 15:12:13 -04:00
// Decide the next mutable operation to perform.
2023-06-22 06:24:44 -04:00
if ( FoundOperation . IsValid ( ) )
2022-09-26 15:12:13 -04:00
{
2023-06-22 06:24:44 -04:00
Private - > CurrentMutableOperation = FoundOperation ;
UCustomizableObjectInstance * FoundInstance = Private - > CurrentMutableOperation - > CustomizableObjectInstance . Get ( ) ;
if ( FoundInstance - > GetPrivate ( ) - > HasCOInstanceFlags ( ForceGenerateAllLODs ) )
{
Private - > CurrentMutableOperation - > bForceGenerateAllLODs = true ;
}
Private - > CurrentMutableOperation - > CustomizableObjectInstance - > GetPrivate ( ) - > InstanceUpdateFlags ( * FoundInstance ) ;
2022-09-26 15:12:13 -04:00
}
else
{
Private - > CurrentMutableOperation = nullptr ;
}
}
// Advance the current operation
if ( Private - > CurrentMutableOperation )
{
AdvanceCurrentOperation ( ) ;
}
2023-05-15 05:50:59 -04:00
2022-09-26 15:12:13 -04:00
// TODO: T2927
if ( LogBenchmarkUtil : : isLoggingActive ( ) )
{
uint64 SizeCache = 0 ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
for ( const UTexture2D * CachedTextures : ProtectedCachedTextures )
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
if ( CachedTextures )
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
SizeCache + = CachedTextures - > CalcTextureMemorySizeEnum ( TMC_AllMips ) ;
2022-09-26 15:12:13 -04:00
}
}
SET_DWORD_STAT ( STAT_MutableTextureCacheMemory , SizeCache / 1024.f ) ;
}
Private - > UpdateStats ( ) ;
# if WITH_EDITOR
TickRecompileCustomizableObjects ( ) ;
# endif
2023-05-15 05:50:59 -04:00
Private - > MutableTaskGraph . Tick ( ) ;
2022-09-26 15:12:13 -04:00
return true ;
}
2023-06-22 06:24:44 -04:00
TAutoConsoleVariable < int32 > CVarMaxNumInstancesToDiscardPerTick (
TEXT ( " mutable.MaxNumInstancesToDiscardPerTick " ) ,
30 ,
TEXT ( " The maximum number of stale instances that will be discarded per tick by Mutable. " ) ,
ECVF_Scalability ) ;
void UCustomizableObjectSystem : : DiscardInstances ( )
{
// Handle instance discards
int32 NumInstancesDiscarded = 0 ;
const int32 DiscardLimitPerTick = CVarMaxNumInstancesToDiscardPerTick . GetValueOnGameThread ( ) ;
for ( auto Iterator = Private - > MutablePendingInstanceWork . GetDiscardIterator ( ) ; Iterator & & NumInstancesDiscarded < DiscardLimitPerTick ; + + Iterator )
{
MUTABLE_CPUPROFILER_SCOPE ( OperationDiscard ) ;
UCustomizableObjectInstance * COI = Iterator - > CustomizableObjectInstance . Get ( ) ;
if ( COI )
{
UCustomizableInstancePrivateData * COIPrivateData = COI ? COI - > GetPrivate ( ) : nullptr ;
// Only discard resources if the instance is still out range (it could have got closer to the player since the task was queued)
if ( ! CurrentInstanceLODManagement - > IsOnlyUpdateCloseCustomizableObjectsEnabled ( ) | |
! COI | |
( ( COIPrivateData ! = nullptr ) & &
( COIPrivateData - > LastMinSquareDistFromComponentToPlayer > FMath : : Square ( CurrentInstanceLODManagement - > GetOnlyUpdateCloseCustomizableObjectsDist ( ) ) )
)
)
{
if ( COI & & COI - > IsValidLowLevel ( ) )
{
check ( COIPrivateData ! = nullptr ) ;
COIPrivateData - > DiscardResourcesAndSetReferenceSkeletalMesh ( COI ) ;
COIPrivateData - > ClearCOInstanceFlags ( Updating ) ;
COI - > SkeletalMeshStatus = ESkeletalMeshState : : Correct ;
}
}
else
{
check ( COIPrivateData ! = nullptr ) ;
COIPrivateData - > ClearCOInstanceFlags ( Updating ) ;
}
if ( COI & & ! COI - > HasAnySkeletalMesh ( ) )
{
// To solve the problem in the Mutable demo where PIE just after editor start made all instances appear as reference mesh until editor restart
check ( COIPrivateData ! = nullptr ) ;
COIPrivateData - > ClearCOInstanceFlags ( Generated ) ;
}
}
Iterator . RemoveCurrent ( ) ;
NumInstancesDiscarded + + ;
}
}
TAutoConsoleVariable < int32 > CVarMaxNumInstanceIDsToReleasePerTick (
TEXT ( " mutable.MaxNumInstanceIDsToReleasePerTick " ) ,
30 ,
TEXT ( " The maximum number of stale instances IDs that will be released per tick by Mutable. " ) ,
ECVF_Scalability ) ;
void UCustomizableObjectSystem : : ReleaseInstanceIDs ( )
{
// Handle ID discards
int32 NumIDsReleased = 0 ;
const int32 IDReleaseLimitPerTick = CVarMaxNumInstanceIDsToReleasePerTick . GetValueOnGameThread ( ) ;
for ( auto Iterator = Private - > MutablePendingInstanceWork . GetIDsToReleaseIterator ( ) ;
Iterator & & NumIDsReleased < IDReleaseLimitPerTick ; + + Iterator )
{
impl : : Task_Game_ReleaseInstanceID ( * Iterator ) ;
Iterator . RemoveCurrent ( ) ;
NumIDsReleased + + ;
}
}
2022-09-26 15:12:13 -04:00
TArray < FCustomizableObjectExternalTexture > UCustomizableObjectSystem : : GetTextureParameterValues ( )
{
TArray < FCustomizableObjectExternalTexture > Result ;
2023-05-24 10:22:36 -04:00
for ( const TWeakObjectPtr < UCustomizableSystemImageProvider > Provider : GetPrivateChecked ( ) - > GetImageProviderChecked ( ) - > ImageProviders )
2022-09-26 15:12:13 -04:00
{
if ( Provider . IsValid ( ) )
{
Provider - > GetTextureParameterValues ( Result ) ;
}
}
return Result ;
}
void UCustomizableObjectSystem : : RegisterImageProvider ( UCustomizableSystemImageProvider * Provider )
{
2023-05-24 10:22:36 -04:00
GetPrivateChecked ( ) - > GetImageProviderChecked ( ) - > ImageProviders . Add ( Provider ) ;
2022-09-26 15:12:13 -04:00
}
void UCustomizableObjectSystem : : UnregisterImageProvider ( UCustomizableSystemImageProvider * Provider )
{
2023-05-24 10:22:36 -04:00
GetPrivateChecked ( ) - > GetImageProviderChecked ( ) - > ImageProviders . Remove ( Provider ) ;
2022-09-26 15:12:13 -04:00
}
2022-11-04 09:18:44 -04:00
2023-01-25 13:01:06 -05:00
UDefaultImageProvider & UCustomizableObjectSystem : : GetOrCreateDefaultImageProvider ( )
2022-11-04 09:18:44 -04:00
{
if ( ! DefaultImageProvider )
{
DefaultImageProvider = NewObject < UDefaultImageProvider > ( ) ;
RegisterImageProvider ( DefaultImageProvider ) ;
}
return * DefaultImageProvider ;
2022-09-26 15:12:13 -04:00
}
2023-08-10 14:14:20 -04:00
static bool bRevertCacheTextureParameters = false ;
static FAutoConsoleVariableRef CVarRevertCacheTextureParameters (
TEXT ( " mutable.RevertCacheTextureParameters " ) , bRevertCacheTextureParameters ,
TEXT ( " If true, FMutableOperation will not cache/uncache texture parameters. If false, FMutableOperation will add an additional reference to the TextureParameters being used in the update. " ) ) ;
void CacheTexturesParameters ( const TArray < FName > & TextureParameters )
{
if ( bRevertCacheTextureParameters )
{
return ;
}
if ( ! TextureParameters . IsEmpty ( ) & & UCustomizableObjectSystem : : IsCreated ( ) )
{
FUnrealMutableImageProvider * ImageProvider = UCustomizableObjectSystem : : GetInstance ( ) - > GetPrivateChecked ( ) - > GetImageProviderChecked ( ) ;
check ( ImageProvider ) ;
for ( const FName & TextureParameter : TextureParameters )
{
ImageProvider - > CacheImage ( TextureParameter , false ) ;
}
}
}
void UnCacheTexturesParameters ( const TArray < FName > & TextureParameters )
{
if ( bRevertCacheTextureParameters )
{
return ;
}
if ( ! TextureParameters . IsEmpty ( ) & & UCustomizableObjectSystem : : IsCreated ( ) )
{
FUnrealMutableImageProvider * ImageProvider = UCustomizableObjectSystem : : GetInstance ( ) - > GetPrivateChecked ( ) - > GetImageProviderChecked ( ) ;
check ( ImageProvider ) ;
for ( const FName & TextureParameter : TextureParameters )
{
ImageProvider - > UnCacheImage ( TextureParameter , false ) ;
}
}
}
FMutableOperation : : FMutableOperation ( const FMutableOperation & Other )
{
bNeverStream = Other . bNeverStream ;
MipsToSkip = Other . MipsToSkip ;
CustomizableObjectInstance = Other . CustomizableObjectInstance ;
InstanceDescriptorRuntimeHash = Other . InstanceDescriptorRuntimeHash ;
bStarted = Other . bStarted ;
bBuildParameterRelevancy = Other . bBuildParameterRelevancy ;
Parameters = Other . Parameters ;
TextureParameters = Other . TextureParameters ;
UpdateCallback = Other . UpdateCallback ;
CacheTexturesParameters ( TextureParameters ) ;
}
FMutableOperation & FMutableOperation : : operator = ( const FMutableOperation & Other )
{
bNeverStream = Other . bNeverStream ;
MipsToSkip = Other . MipsToSkip ;
CustomizableObjectInstance = Other . CustomizableObjectInstance ;
InstanceDescriptorRuntimeHash = Other . InstanceDescriptorRuntimeHash ;
bStarted = Other . bStarted ;
bBuildParameterRelevancy = Other . bBuildParameterRelevancy ;
Parameters = Other . Parameters ;
TextureParameters = Other . TextureParameters ;
UpdateCallback = Other . UpdateCallback ;
CacheTexturesParameters ( TextureParameters ) ;
return * this ;
}
FMutableOperation : : ~ FMutableOperation ( )
{
// Uncache Texture Parameters
UnCacheTexturesParameters ( TextureParameters ) ;
}
2022-09-26 15:12:13 -04:00
2023-04-06 16:56:51 -04:00
FMutableOperation FMutableOperation : : CreateInstanceUpdate ( UCustomizableObjectInstance * InCustomizableObjectInstance , bool bInNeverStream , int32 InMipsToSkip , const FInstanceUpdateDelegate * UpdateCallback )
2022-09-26 15:12:13 -04:00
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( InCustomizableObjectInstance ! = nullptr ) ;
check ( InCustomizableObjectInstance - > GetPrivate ( ) ! = nullptr ) ;
check ( InCustomizableObjectInstance - > GetCustomizableObject ( ) ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
FMutableOperation Op ;
Op . bNeverStream = bInNeverStream ;
Op . MipsToSkip = InMipsToSkip ;
Op . CustomizableObjectInstance = InCustomizableObjectInstance ;
2022-10-26 22:18:24 -04:00
Op . InstanceDescriptorRuntimeHash = InCustomizableObjectInstance - > GetUpdateDescriptorRuntimeHash ( ) ;
2022-09-26 15:12:13 -04:00
Op . bStarted = false ;
2023-04-25 06:07:49 -04:00
Op . bBuildParameterRelevancy = InCustomizableObjectInstance - > GetBuildParameterRelevancy ( ) ;
2023-07-21 03:28:52 -04:00
Op . Parameters = InCustomizableObjectInstance - > GetDescriptor ( ) . GetParameters ( ) ;
2023-08-10 14:14:20 -04:00
Op . TextureParameters = InCustomizableObjectInstance - > GetPrivate ( ) - > UpdateTextureParameters ;
2023-06-22 06:24:44 -04:00
2023-04-06 16:56:51 -04:00
if ( UpdateCallback )
{
Op . UpdateCallback = * UpdateCallback ;
}
2022-09-26 15:12:13 -04:00
InCustomizableObjectInstance - > GetCustomizableObject ( ) - > ApplyStateForcedValuesToParameters ( InCustomizableObjectInstance - > GetState ( ) , Op . Parameters . get ( ) ) ;
if ( ! Op . Parameters )
{
// Cancel the update because the parameters aren't valid, probably because the object is not compiled
Op . CustomizableObjectInstance = nullptr ;
}
2023-08-10 14:14:20 -04:00
CacheTexturesParameters ( Op . TextureParameters ) ;
2022-09-26 15:12:13 -04:00
return Op ;
}
int32 UCustomizableObjectSystem : : GetNumInstances ( ) const
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
return Private - > NumInstances ;
}
int32 UCustomizableObjectSystem : : GetNumPendingInstances ( ) const
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
return Private - > NumPendingInstances ;
}
int32 UCustomizableObjectSystem : : GetTotalInstances ( ) const
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
return Private - > TotalInstances ;
}
int32 UCustomizableObjectSystem : : GetTextureMemoryUsed ( ) const
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
return int32 ( Private - > TextureMemoryUsed ) ;
}
int32 UCustomizableObjectSystem : : GetAverageBuildTime ( ) const
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
return Private - > TotalBuiltInstances = = 0 ? 0 : Private - > TotalBuildMs / Private - > TotalBuiltInstances ;
}
bool UCustomizableObjectSystem : : IsSupport16BitBoneIndexEnabled ( ) const
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
return Private - > bSupport16BitBoneIndex ;
}
2023-01-24 08:45:18 -05:00
2022-09-26 15:12:13 -04:00
bool UCustomizableObjectSystem : : IsProgressiveMipStreamingEnabled ( ) const
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
return Private - > EnableMutableProgressiveMipStreaming ! = 0 ;
}
2023-02-16 01:44:25 -05:00
void UCustomizableObjectSystem : : SetProgressiveMipStreamingEnabled ( bool bIsEnabled )
{
check ( Private ! = nullptr ) ;
Private - > EnableMutableProgressiveMipStreaming = bIsEnabled ? 1 : 0 ;
}
2023-01-24 08:45:18 -05:00
bool UCustomizableObjectSystem : : IsOnlyGenerateRequestedLODsEnabled ( ) const
{
check ( Private ! = nullptr ) ;
2023-01-27 14:45:45 -05:00
return Private - > EnableOnlyGenerateRequestedLODs ! = 0 ;
2023-01-24 08:45:18 -05:00
}
2023-02-16 01:44:25 -05:00
void UCustomizableObjectSystem : : SetOnlyGenerateRequestedLODsEnabled ( bool bIsEnabled )
{
check ( Private ! = nullptr ) ;
Private - > EnableOnlyGenerateRequestedLODs = bIsEnabled ? 1 : 0 ;
}
2023-06-12 09:36:23 -04:00
void UCustomizableObjectSystem : : AddUncompiledCOWarning ( const UCustomizableObject & InObject , FString const * OptionalLogInfo )
2022-09-26 15:12:13 -04:00
{
FString Msg ;
2023-06-28 03:48:44 -04:00
Msg + = FString : : Printf ( TEXT ( " Warning: Customizable Object [%s] not compiled. " ) , * InObject . GetName ( ) ) ;
2023-06-12 09:36:23 -04:00
GEngine - > AddOnScreenDebugMessage ( ( uint64 ) ( ( PTRINT ) & InObject ) , 10.0f , FColor : : Red , Msg ) ;
2022-09-26 15:12:13 -04:00
Added logging an Error to UCustomizableObjectSystem::AddUncompiledCOWarning, and also added an optional parameter for the caller to add more info to the log (so we can easily log the source of the call to figure out what is being called that is trying to use a CO that hasn't been compiled yet).
Created a private helper function FCustomizableObjectInstanceDescriptor::AddUncompiledCOWarning(...), which makes sure the System exists, is valid, and isn't being destroyed before calling to AddUncompiledCOWarning on the System.
SetIntParameterSelectedOption(FString ParameterName,...) now ensures and calls to AddUncompiledCOWarning (which logs an error, makes an on-screen display, and sends a notfiication in Editor) if the CO that the descriptor is associated with is not compiled. If it is compiled, but the named parameter is not found, it ensures (in non-shipping builds only) and logs an error (in all builds).
SetIntParameterSelectedOption((const int32 IntParamIndex, ...) now also ensure and calls AddUncompiledCOWarning as the string version does if its CO is not compiled. If it is compiled, but the IntParamIndex is invalid, it logs an error and bails.
(We should make similar ensure/logging changes to all other parameter type setters.
I'll investigate that in the near future.)
#RB Joel.Anderson, Pere.Rifa
#UE5
[CL 25219708 by daniel broder in ue5-main branch]
2023-04-27 14:01:55 -04:00
# if WITH_EDITOR
2023-06-28 03:48:44 -04:00
// Mutable will spam these warnings constantly due to the tick and LOD manager checking for instances to update with every tick. Send only one message per CO in the editor.
if ( UncompiledCustomizableObjectIds . Find ( InObject . GetVersionId ( ) ) ! = INDEX_NONE )
{
return ;
}
// Add notification
UncompiledCustomizableObjectIds . Add ( InObject . GetVersionId ( ) ) ;
FMessageLog MessageLog ( " Mutable " ) ;
MessageLog . Warning ( FText : : FromString ( Msg ) ) ;
if ( ! UncompiledCustomizableObjectsNotificationPtr . IsValid ( ) )
{
FNotificationInfo Info ( FText : : FromString ( " Uncompiled Customizable Object/s found. Please, check the Message Log - Mutable for more information. " ) ) ;
Info . bFireAndForget = true ;
Info . bUseThrobber = true ;
Info . FadeOutDuration = 1.0f ;
Info . ExpireDuration = 5.0f ;
UncompiledCustomizableObjectsNotificationPtr = FSlateNotificationManager : : Get ( ) . AddNotification ( Info ) ;
}
Added logging an Error to UCustomizableObjectSystem::AddUncompiledCOWarning, and also added an optional parameter for the caller to add more info to the log (so we can easily log the source of the call to figure out what is being called that is trying to use a CO that hasn't been compiled yet).
Created a private helper function FCustomizableObjectInstanceDescriptor::AddUncompiledCOWarning(...), which makes sure the System exists, is valid, and isn't being destroyed before calling to AddUncompiledCOWarning on the System.
SetIntParameterSelectedOption(FString ParameterName,...) now ensures and calls to AddUncompiledCOWarning (which logs an error, makes an on-screen display, and sends a notfiication in Editor) if the CO that the descriptor is associated with is not compiled. If it is compiled, but the named parameter is not found, it ensures (in non-shipping builds only) and logs an error (in all builds).
SetIntParameterSelectedOption((const int32 IntParamIndex, ...) now also ensure and calls AddUncompiledCOWarning as the string version does if its CO is not compiled. If it is compiled, but the IntParamIndex is invalid, it logs an error and bails.
(We should make similar ensure/logging changes to all other parameter type setters.
I'll investigate that in the near future.)
#RB Joel.Anderson, Pere.Rifa
#UE5
[CL 25219708 by daniel broder in ue5-main branch]
2023-04-27 14:01:55 -04:00
const FString ErrorString = FString : : Printf (
TEXT ( " Customizable Object [%s] not compiled. Compile via the editor or via code before instancing. %s " ) ,
2023-06-28 03:48:44 -04:00
* InObject . GetName ( ) , OptionalLogInfo ? * * OptionalLogInfo : TEXT ( " " ) ) ;
Added logging an Error to UCustomizableObjectSystem::AddUncompiledCOWarning, and also added an optional parameter for the caller to add more info to the log (so we can easily log the source of the call to figure out what is being called that is trying to use a CO that hasn't been compiled yet).
Created a private helper function FCustomizableObjectInstanceDescriptor::AddUncompiledCOWarning(...), which makes sure the System exists, is valid, and isn't being destroyed before calling to AddUncompiledCOWarning on the System.
SetIntParameterSelectedOption(FString ParameterName,...) now ensures and calls to AddUncompiledCOWarning (which logs an error, makes an on-screen display, and sends a notfiication in Editor) if the CO that the descriptor is associated with is not compiled. If it is compiled, but the named parameter is not found, it ensures (in non-shipping builds only) and logs an error (in all builds).
SetIntParameterSelectedOption((const int32 IntParamIndex, ...) now also ensure and calls AddUncompiledCOWarning as the string version does if its CO is not compiled. If it is compiled, but the IntParamIndex is invalid, it logs an error and bails.
(We should make similar ensure/logging changes to all other parameter type setters.
I'll investigate that in the near future.)
#RB Joel.Anderson, Pere.Rifa
#UE5
[CL 25219708 by daniel broder in ue5-main branch]
2023-04-27 14:01:55 -04:00
# else // !WITH_EDITOR
const FString ErrorString = FString : : Printf (
2023-04-27 14:07:44 -04:00
TEXT ( " Customizable Object [%s] not compiled. This is not an Editor build, so this is an unrecoverable bad state; could be due to code or a cook failure. %s " ) ,
2023-06-28 03:48:44 -04:00
* InObject . GetName ( ) , OptionalLogInfo ? * * OptionalLogInfo : TEXT ( " " ) ) ;
Added logging an Error to UCustomizableObjectSystem::AddUncompiledCOWarning, and also added an optional parameter for the caller to add more info to the log (so we can easily log the source of the call to figure out what is being called that is trying to use a CO that hasn't been compiled yet).
Created a private helper function FCustomizableObjectInstanceDescriptor::AddUncompiledCOWarning(...), which makes sure the System exists, is valid, and isn't being destroyed before calling to AddUncompiledCOWarning on the System.
SetIntParameterSelectedOption(FString ParameterName,...) now ensures and calls to AddUncompiledCOWarning (which logs an error, makes an on-screen display, and sends a notfiication in Editor) if the CO that the descriptor is associated with is not compiled. If it is compiled, but the named parameter is not found, it ensures (in non-shipping builds only) and logs an error (in all builds).
SetIntParameterSelectedOption((const int32 IntParamIndex, ...) now also ensure and calls AddUncompiledCOWarning as the string version does if its CO is not compiled. If it is compiled, but the IntParamIndex is invalid, it logs an error and bails.
(We should make similar ensure/logging changes to all other parameter type setters.
I'll investigate that in the near future.)
#RB Joel.Anderson, Pere.Rifa
#UE5
[CL 25219708 by daniel broder in ue5-main branch]
2023-04-27 14:01:55 -04:00
# endif
// Also log an error so if this happens as part of a bug report we'll have this info.
UE_LOG ( LogMutable , Error , TEXT ( " %s " ) , * ErrorString ) ;
2022-09-26 15:12:13 -04:00
}
void UCustomizableObjectSystem : : EnableBenchmark ( )
{
LogBenchmarkUtil : : startLogging ( ) ;
}
void UCustomizableObjectSystem : : EndBenchmark ( )
{
LogBenchmarkUtil : : shutdownAndSaveResults ( ) ;
}
void UCustomizableObjectSystem : : SetReleaseMutableTexturesImmediately ( bool bReleaseTextures )
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( Private ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
Private - > bReleaseTexturesImmediately = bReleaseTextures ;
}
# if WITH_EDITOR
void UCustomizableObjectSystem : : OnPreBeginPIE ( const bool bIsSimulatingInEditor )
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
if ( ! EditorSettings . bCompileRootObjectsOnStartPIE | | IsRunningGame ( ) | | IsCompilationDisabled ( ) )
2022-09-26 15:12:13 -04:00
{
return ;
}
// Find root customizable objects
FARFilter AssetRegistryFilter ;
2023-04-04 06:06:06 -04:00
UE_MUTABLE_GET_CLASSPATHS ( AssetRegistryFilter ) . Add ( UE_MUTABLE_TOPLEVELASSETPATH ( TEXT ( " /Script/CustomizableObject " ) , TEXT ( " CustomizableObject " ) ) ) ;
2022-09-26 15:12:13 -04:00
AssetRegistryFilter . TagsAndValues . Add ( FName ( " IsRoot " ) , FString : : FromInt ( 1 ) ) ;
TArray < FAssetData > OutAssets ;
const FAssetRegistryModule & AssetRegistryModule = FModuleManager : : LoadModuleChecked < FAssetRegistryModule > ( " AssetRegistry " ) ;
AssetRegistryModule . Get ( ) . GetAssets ( AssetRegistryFilter , OutAssets ) ;
TArray < FAssetData > TempObjectsToRecompile ;
for ( const FAssetData & Asset : OutAssets )
{
// If it is referenced by PIE it should be loaded
if ( ! Asset . IsAssetLoaded ( ) )
{
continue ;
}
const UCustomizableObject * Object = Cast < UCustomizableObject > ( Asset . GetAsset ( ) ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
if ( ! Object | | Object - > IsCompiled ( ) | | Object - > IsLocked ( ) | | Object - > bIsChildObject )
2022-09-26 15:12:13 -04:00
{
continue ;
}
// Add uncompiled objects to the objects to cook list
TempObjectsToRecompile . Add ( Asset ) ;
}
if ( ! TempObjectsToRecompile . IsEmpty ( ) )
{
FText Msg = FText : : FromString ( TEXT ( " Warning: one or more Customizable Objects used in PIE are uncompiled. \n \n Do you want to compile them? " ) ) ;
if ( FMessageDialog : : Open ( EAppMsgType : : OkCancel , Msg ) = = EAppReturnType : : Ok )
{
ObjectsToRecompile . Empty ( TempObjectsToRecompile . Num ( ) ) ;
RecompileCustomizableObjects ( TempObjectsToRecompile ) ;
}
}
}
void UCustomizableObjectSystem : : StartNextRecompile ( )
{
2023-06-28 03:48:44 -04:00
CollectGarbage ( GARBAGE_COLLECTION_KEEPFLAGS ) ;
2022-09-26 15:12:13 -04:00
FAssetData Itr = ObjectsToRecompile . Pop ( ) ;
UCustomizableObject * CustomizableObject = Cast < UCustomizableObject > ( Itr . GetAsset ( ) ) ;
if ( CustomizableObject )
{
FText UpdateMsg = FText : : FromString ( FString : : Printf ( TEXT ( " Compiling Customizable Objects: \n %s " ) , * CustomizableObject - > GetName ( ) ) ) ;
FSlateNotificationManager : : Get ( ) . UpdateProgressNotification ( RecompileNotificationHandle , NumObjectsCompiled , TotalNumObjectsToRecompile , UpdateMsg ) ;
// Use default options
FCompilationOptions Options = CustomizableObject - > CompileOptions ;
Options . bSilentCompilation = true ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
check ( RecompileCustomizableObjectsCompiler ! = nullptr ) ;
2022-09-26 15:12:13 -04:00
RecompileCustomizableObjectsCompiler - > Compile ( * CustomizableObject , Options , true ) ;
}
}
void UCustomizableObjectSystem : : RecompileCustomizableObjectAsync ( const FAssetData & InAssetData ,
const UCustomizableObject * InObject )
{
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
if ( IsRunningGame ( ) | | IsCompilationDisabled ( ) )
2022-09-26 15:12:13 -04:00
{
return ;
}
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
if ( ( InObject & & InObject - > IsLocked ( ) ) | | ObjectsToRecompile . Find ( ( InAssetData ) ) ! = INDEX_NONE )
2022-09-26 15:12:13 -04:00
{
return ;
}
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
if ( ! ObjectsToRecompile . IsEmpty ( ) )
2022-09-26 15:12:13 -04:00
{
ObjectsToRecompile . Add ( InAssetData ) ;
}
else
{
RecompileCustomizableObjects ( { InAssetData } ) ;
}
}
void UCustomizableObjectSystem : : RecompileCustomizableObjects ( const TArray < FAssetData > & InObjects )
{
if ( IsRunningGame ( ) | | IsCompilationDisabled ( ) )
{
return ;
}
if ( InObjects . Num ( ) )
{
if ( ! RecompileCustomizableObjectsCompiler )
{
RecompileCustomizableObjectsCompiler = GetNewCompiler ( ) ;
if ( ! RecompileCustomizableObjectsCompiler )
{
return ;
}
}
ObjectsToRecompile . Append ( InObjects ) ;
TotalNumObjectsToRecompile = ObjectsToRecompile . Num ( ) ;
NumObjectsCompiled = 0 ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
if ( RecompileNotificationHandle . IsValid ( ) )
2022-09-26 15:12:13 -04:00
{
+ + TotalNumObjectsToRecompile ;
FSlateNotificationManager : : Get ( ) . UpdateProgressNotification ( RecompileNotificationHandle , NumObjectsCompiled , TotalNumObjectsToRecompile ) ;
}
else
{
RecompileNotificationHandle = FSlateNotificationManager : : Get ( ) . StartProgressNotification ( FText : : FromString ( TEXT ( " Compiling Customizable Objects " ) ) , TotalNumObjectsToRecompile ) ;
StartNextRecompile ( ) ;
}
}
}
void UCustomizableObjectSystem : : TickRecompileCustomizableObjects ( )
{
bool bUpdated = false ;
if ( RecompileCustomizableObjectsCompiler )
{
bUpdated = RecompileCustomizableObjectsCompiler - > Tick ( ) | | RecompileCustomizableObjectsCompiler - > GetCompilationState ( ) = = ECustomizableObjectCompilationState : : Failed ;
}
if ( bUpdated )
{
NumObjectsCompiled + + ;
if ( ! ObjectsToRecompile . IsEmpty ( ) )
{
StartNextRecompile ( ) ;
}
else // All objects compiled, clean up
{
// Delete compiler
delete RecompileCustomizableObjectsCompiler ;
RecompileCustomizableObjectsCompiler = nullptr ;
// Remove progress bar
FSlateNotificationManager : : Get ( ) . UpdateProgressNotification ( RecompileNotificationHandle , NumObjectsCompiled , TotalNumObjectsToRecompile ) ;
FSlateNotificationManager : : Get ( ) . CancelProgressNotification ( RecompileNotificationHandle ) ;
RecompileNotificationHandle . Reset ( ) ;
CollectGarbage ( GARBAGE_COLLECTION_KEEPFLAGS ) ;
}
}
}
uint64 UCustomizableObjectSystem : : GetMaxChunkSizeForPlatform ( const ITargetPlatform * TargetPlatform )
{
const FString & PlatformName = TargetPlatform ? TargetPlatform - > IniPlatformName ( ) : FPlatformProperties : : IniPlatformName ( ) ;
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
if ( const int64 * CachedMaxChunkSize = PlatformMaxChunkSize . Find ( PlatformName ) )
2022-09-26 15:12:13 -04:00
{
return * CachedMaxChunkSize ;
}
int64 MaxChunkSize = - 1 ;
if ( ! FParse : : Value ( FCommandLine : : Get ( ) , TEXT ( " ExtraFlavorChunkSize= " ) , MaxChunkSize ) | | MaxChunkSize < 0 )
{
FConfigFile PlatformIniFile ;
FConfigCacheIni : : LoadLocalIniFile ( PlatformIniFile , TEXT ( " Game " ) , true , * PlatformName ) ;
FString ConfigString ;
if ( PlatformIniFile . GetString ( TEXT ( " /Script/UnrealEd.ProjectPackagingSettings " ) , TEXT ( " MaxChunkSize " ) , ConfigString ) )
{
MaxChunkSize = FCString : : Atoi64 ( * ConfigString ) ;
}
}
// If no limit is specified default it to MUTABLE_STREAMED_DATA_MAXCHUNKSIZE
While Investigating a client hang, found some code that is either unsafe, not clearly safe, or violates UE coding standards.
Code cleanup:
* Added a lot of checks() to make sure we crash explicitly with useful information rather than hoping a crash will have enough info to work from.
** NOTE: I'm aware that _some_ of the "GetPrivate()" calls have a check internal to them, but they're not named to indicate that, so it may change, and other GetPrivate() calls do NOT have internal checks for nullptr. So to reduce the need for specific implementation knowledge and the possible confusion between them, I just re-assert in those cases if the pointer is nullptr.
* Fixed a number of coding standard issues, including:
** Variable names must start with initial capitals
** Spacing, indentation, and bracing issues that didn't match UE coding standards.
* Cleaned up some other spacing and indentation issues to be consistent within the file and for general readability.
Also, removed a line of code that would cause a crash due to dereferencing a pointer that's guaranteed to be nullptr or invalid.
Added a few temporary comments to investigate some other oddities in the code.
#RB Alexei.Lebedev, Pere.Rifa, Joel.Anderson
#UE5 #RNX #NoReleaseNotes
[CL 23519838 by daniel broder in ue5-main branch]
2022-12-14 17:05:40 -05:00
if ( MaxChunkSize < = 0 )
2022-09-26 15:12:13 -04:00
{
MaxChunkSize = MUTABLE_STREAMED_DATA_MAXCHUNKSIZE ;
}
PlatformMaxChunkSize . Add ( PlatformName , MaxChunkSize ) ;
return MaxChunkSize ;
}
2022-11-04 09:18:44 -04:00
# endif // WITH_EDITOR
2022-10-04 09:10:32 -04:00
2023-07-31 03:24:06 -04:00
void UCustomizableObjectSystem : : CacheImage ( FName ImageId )
2022-10-04 09:10:32 -04:00
{
2023-05-24 10:22:36 -04:00
GetPrivateChecked ( ) - > GetImageProviderChecked ( ) - > CacheImage ( ImageId , true ) ;
2022-10-04 09:10:32 -04:00
}
2023-07-31 03:24:06 -04:00
void UCustomizableObjectSystem : : UnCacheImage ( FName ImageId )
2022-10-04 09:10:32 -04:00
{
2023-05-24 10:22:36 -04:00
GetPrivateChecked ( ) - > GetImageProviderChecked ( ) - > UnCacheImage ( ImageId , true ) ;
2022-10-04 09:10:32 -04:00
}
void UCustomizableObjectSystem : : ClearImageCache ( )
{
2023-05-24 10:22:36 -04:00
GetPrivateChecked ( ) - > GetImageProviderChecked ( ) - > ClearCache ( true ) ;
2022-11-22 04:57:22 -05:00
}
bool FCustomizableObjectSystemPrivate : : IsMutableAnimInfoDebuggingEnabled ( ) const
{
# if WITH_EDITORONLY_DATA
return EnableMutableAnimInfoDebugging > 0 ;
# else
return false ;
# endif
}
2023-05-24 10:22:36 -04:00
FUnrealMutableImageProvider * FCustomizableObjectSystemPrivate : : GetImageProviderChecked ( ) const
{
check ( ImageProvider )
return ImageProvider . Get ( ) ;
}
2022-11-22 04:57:22 -05:00
bool UCustomizableObjectSystem : : IsMutableAnimInfoDebuggingEnabled ( ) const
{
# if WITH_EDITOR
2023-05-24 10:22:36 -04:00
return GetPrivateChecked ( ) - > IsMutableAnimInfoDebuggingEnabled ( ) ;
2022-11-22 04:57:22 -05:00
# else
return false ;
# endif
}