Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-04-07 18:02:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #540 from overte-org/fix/entity_script_deadlock

Browse source 
Fixed deadlock when entity script engines are being reset.
This commit is contained in:
Dale Glass 2023-08-05 22:19:24 +02:00 committed by GitHub
commit 7a91b74c94
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
libraries/entities-renderer/src/EntityTreeRenderer.cpp
View file

@ -42,6 +42,7 @@
#include "RenderableWebEntityItem.h"
#include <PointerManager.h>
#include <QtConcurrent/QtConcurrentRun>
std::function<bool()> EntityTreeRenderer::_entitiesShouldFadeFunction = []() { return true; };
@ -217,11 +218,15 @@ void EntityTreeRenderer::setupEntityScriptEngineSignals(const ScriptManagerPoint
}
void EntityTreeRenderer::resetPersistentEntitiesScriptEngine() {
// This runs script engine shutdown procedure in a separate thread, avoiding a deadlock when script engine is doing
// a blocking call to main thread
if (_persistentEntitiesScriptManager) {
_persistentEntitiesScriptManager->unloadAllEntityScripts(true);
_persistentEntitiesScriptManager->stop();
_persistentEntitiesScriptManager->waitTillDoneRunning();
_persistentEntitiesScriptManager->disconnectNonEssentialSignals();
QtConcurrent::run([manager = _persistentEntitiesScriptManager] {
manager->unloadAllEntityScripts(true);
manager->stop();
manager->waitTillDoneRunning();
manager->disconnectNonEssentialSignals();
});
}
_persistentEntitiesScriptManager = scriptManagerFactory(ScriptManager::ENTITY_CLIENT_SCRIPT, NO_SCRIPT,
QString("about:Entities %1").arg(++_entitiesScriptEngineCount));
@ -235,11 +240,15 @@ void EntityTreeRenderer::resetPersistentEntitiesScriptEngine() {
}
void EntityTreeRenderer::resetNonPersistentEntitiesScriptEngine() {
// This runs script engine shutdown procedure in a separate thread, avoiding a deadlock when script engine is doing
// a blocking call to main thread
if (_nonPersistentEntitiesScriptManager) {
_nonPersistentEntitiesScriptManager->unloadAllEntityScripts(true);
_nonPersistentEntitiesScriptManager->stop();
_nonPersistentEntitiesScriptManager->waitTillDoneRunning();
_nonPersistentEntitiesScriptManager->disconnectNonEssentialSignals();
QtConcurrent::run([manager = _nonPersistentEntitiesScriptManager] {
manager->unloadAllEntityScripts(true);
manager->stop();
manager->waitTillDoneRunning();
manager->disconnectNonEssentialSignals();
});
}
_nonPersistentEntitiesScriptManager = scriptManagerFactory(ScriptManager::ENTITY_CLIENT_SCRIPT, NO_SCRIPT,
QString("about:Entities %1").arg(++_entitiesScriptEngineCount));
@ -311,11 +320,23 @@ void EntityTreeRenderer::clear() {
// unload and stop the engines
if (_nonPersistentEntitiesScriptManager) {
// do this here (instead of in deleter) to avoid marshalling unload signals back to this thread
// TODO: blocking call will cause deadlocks if the script engine is doing blocking call to main thread,
// for example to access resource cache.
// Since there's no event loop running at this time anymore, I have no easy workaround for this.
// This could be solved by replacing all calls to quit() with calls to a new function that will do
// a cleanup first while event loop is still running
_nonPersistentEntitiesScriptManager->unloadAllEntityScripts(true);
_nonPersistentEntitiesScriptManager->stop();
}
if (_persistentEntitiesScriptManager) {
// do this here (instead of in deleter) to avoid marshalling unload signals back to this thread
// TODO: blocking call will cause deadlocks if the script engine is doing blocking call to main thread,
// for example to access resource cache.
// Since there's no event loop running at this time anymore, I have no easy workaround for this.
// This could be solved by replacing all calls to quit() with calls to a new function that will do
// a cleanup first while event loop is still running
_persistentEntitiesScriptManager->unloadAllEntityScripts(true);
_persistentEntitiesScriptManager->stop();
}