Files
UnrealEngineUWP/Engine/Source/Developer/Windows/LiveCoding/Private/External/LC_ClientCommandActions.cpp
Johan Torp ccd9c2597d FName optimizations and improvements
Encoding improvements
* New hash table implementation
--- Move away from 16-bit hashes since we need more than 64k buckets to hold 2M entries efficiently
--- Change to CityHash64, which is faster and stronger
--- Remove hardcoded max limit
* NAME_INDEX changed from contigouos int to monotonically increasing int
--- Opens up for future deduplication schemes that are better than number suffix dedup.
--- Saves some memory since we don't need to maintain a contiguous array
--- Typed up to cause compile errors when used as integer directly
* Avoid touching data repeatedly, normal path only does single hash of data
* New constructor that allows supplying string length up front
* Avoid dynamic allocations in string conversions >= 128 characters
* Avoid extra copying when splitting numbers
* More efficient IsPureAnsi check
* Only do one global lazy initialization call instead of multiple
* Switch to faster RW locks
* Switch from single lock to sharded hash map with separate locks
* Memory optimizations that reduces per entry overhead: 4 bytes slots, 2 byte headers and don't store null terminator

Improved API & documentation
* Document that IsValid() rarely makes sense
* Hide global state such as GetNames()
* Reduce amount of implementation details visible in header
* NameTypes.h size down by ~1/3 while adding documentation, stronger type safety and new APIs

Future possibilities
* Memory savings: Removing public NAME_INDEX and global FName array allows using the 32-bit FNameEntryId for arbitrary deduplication schemes. This can save both actual stored strings memory by deduplication and half the size of FName instances from 8B to 4B in shipping / test configs by removing the number part.
* Implementation can be tweaked further, for instance could persist 32-bit slot index hash inside slot to increase encoding performance in development / debug at the cost of memory.

Perf & mem results for internal project:
* Editor startup wall time: 12% speedup, 22.0s -> 19.5s
--- Warm disk and asset registry cache
--- Some gains from nametable serialization improvements
--- Some of these gains might be from orthogonal asset discovery optimizations
* Win64 Test Client memory usage with ~400k names: 30.3Mb -> 22.2Mb

#rb steve.robb, pj.kack
#jira UE-59973

[CL 5774657 by Johan Torp in Dev-Core branch]
2019-04-08 11:29:35 -04:00

222 lines
5.1 KiB
C++

// Copyright 2011-2019 Molecular Matters GmbH, all rights reserved.
#include "LC_ClientCommandActions.h"
#include "LC_ClientUserCommandThread.h"
#include "LC_DuplexPipe.h"
#include "LC_SyncPoint.h"
#include "LC_Executable.h"
#include "LC_Event.h"
#include "LC_Process.h"
#include "LC_Logging.h"
bool actions::RegisterProcessFinished::Execute(CommandType* command, const DuplexPipe* pipe, void* context)
{
pipe->SendAck();
bool* successfullyRegisteredProcess = static_cast<bool*>(context);
*successfullyRegisteredProcess = command->success;
// don't continue execution
return false;
}
bool actions::EnableModuleFinished::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
Event* event = static_cast<Event*>(command->token);
event->Signal();
pipe->SendAck();
return false;
}
bool actions::DisableModuleFinished::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
Event* event = static_cast<Event*>(command->token);
event->Signal();
pipe->SendAck();
return false;
}
bool actions::EnableAllModulesFinished::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
Event* event = static_cast<Event*>(command->token);
event->Signal();
pipe->SendAck();
return false;
}
bool actions::DisableAllModulesFinished::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
Event* event = static_cast<Event*>(command->token);
event->Signal();
pipe->SendAck();
return false;
}
bool actions::EnterSyncPoint::Execute(CommandType*, const DuplexPipe* pipe, void*)
{
syncPoint::Enter();
pipe->SendAck();
return true;
}
bool actions::LeaveSyncPoint::Execute(CommandType*, const DuplexPipe* pipe, void*)
{
syncPoint::Leave();
pipe->SendAck();
return true;
}
bool actions::CallHooks::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
for (const hook::Function* hook = command->first; hook < command->last; ++hook)
{
// note that sections are often padded with zeroes, so skip everything that's zero
hook::Function function = *hook;
if (function)
{
function();
}
}
pipe->SendAck();
return true;
}
bool actions::GetModule::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
HMODULE module = ::GetModuleHandleW(command->path);
if (module)
{
wchar_t fullPath[MAX_PATH];
::GetModuleFileNameW(module, fullPath, MAX_PATH);
// send back command with module info
{
commands::GetModuleInfo cmd = { module, process::GetId(), command->loadImports, command->taskContext };
wcscpy_s(cmd.path, fullPath);
pipe->SendAck();
pipe->SendCommandAndWaitForAck(cmd);
}
}
else
{
pipe->SendAck();
pipe->SendCommandAndWaitForAck(commands::GetModuleInfo { nullptr, process::GetId(), command->loadImports, command->taskContext });
}
return true;
}
// BEGIN EPIC MOD - Support for UE4 debug visualizers
extern uint8** GNameBlocksDebug;
class FChunkedFixedUObjectArray;
extern FChunkedFixedUObjectArray*& GObjectArrayForDebugVisualizers;
// END EPIC MOD
bool actions::LoadPatch::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
// load library into this process
HMODULE module = ::LoadLibraryW(command->path);
// BEGIN EPIC MOD - Support for UE4 debug visualizers
if (module != nullptr)
{
typedef void InitNatvisHelpersFunc(uint8** NameTable, FChunkedFixedUObjectArray* ObjectArray);
InitNatvisHelpersFunc* InitNatvisHelpers = (InitNatvisHelpersFunc*)(void*)GetProcAddress(module, "InitNatvisHelpers");
if (InitNatvisHelpers != nullptr)
{
(*InitNatvisHelpers)(GNameBlocksDebug, GObjectArrayForDebugVisualizers);
}
}
// END EPIC MOD
pipe->SendAck();
// send back command with module info
pipe->SendCommandAndWaitForAck(commands::LoadPatchInfo { module });
return true;
}
bool actions::UnloadPatch::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
// unload library from this process
::FreeLibrary(command->module);
pipe->SendAck();
return true;
}
bool actions::CallEntryPoint::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
executable::CallDllEntryPoint(command->moduleBase, command->entryPointRva);
pipe->SendAck();
return true;
}
bool actions::LogOutput::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
logging::LogNoFormat<logging::Channel::USER>(command->buffer);
pipe->SendAck();
return true;
}
// BEGIN EPIC MOD - Notification that compilation has finished
extern bool GIsCompileActive;
// END EPIC MOD
bool actions::CompilationFinished::Execute(CommandType*, const DuplexPipe* pipe, void*)
{
pipe->SendAck();
// BEGIN EPIC MOD - Notification that compilation has finished
GIsCompileActive = false;
// END EPIC MOD
// don't continue execution
return false;
}
bool actions::HandleExceptionFinished::Execute(CommandType* command, const DuplexPipe* pipe, void* context)
{
ClientUserCommandThread::ExceptionResult* resultContext = static_cast<ClientUserCommandThread::ExceptionResult*>(context);
resultContext->returnAddress = command->returnAddress;
resultContext->framePointer = command->framePointer;
resultContext->stackPointer = command->stackPointer;
resultContext->continueExecution = command->continueExecution;
pipe->SendAck();
// don't continue execution
return false;
}