fix(plugins): prevent callback races

Lifecycle callbacks can be registered while
another thread dispatches them, risking races
and iterator invalidation.

Snapshot shared callback objects under a mutex,
then invoke them unlocked to preserve reentrancy
and mutable callback state.
This commit is contained in:
Andrew
2026-07-13 17:25:39 +08:00
parent 592e5f92f8
commit b4c9747f09
6 changed files with 168 additions and 14 deletions

View File

@@ -616,6 +616,7 @@ set(SLIC3R_GUI_SOURCES
plugin/PluginFsUtils.hpp
plugin/PluginCatalog.cpp
plugin/PluginCatalog.hpp
plugin/PluginCallbackList.hpp
plugin/PluginLoader.cpp
plugin/PluginLoader.hpp
plugin/PluginDescriptor.hpp

View File

@@ -0,0 +1,44 @@
#pragma once
#include <functional>
#include <memory>
#include <mutex>
#include <utility>
#include <vector>
namespace Slic3r {
// Thread-safe append-only callback storage. Each dispatch operates on a snapshot,
// so callbacks may safely subscribe more callbacks without deadlocking or changing
// the in-flight dispatch.
template<typename Signature> class PluginCallbackList
{
public:
using Callback = std::function<Signature>;
using CallbackPtr = std::shared_ptr<Callback>;
void subscribe(Callback callback)
{
auto owned_callback = std::make_shared<Callback>(std::move(callback));
std::lock_guard<std::mutex> lock(m_mutex);
m_callbacks.emplace_back(std::move(owned_callback));
}
template<typename Dispatcher> void dispatch(Dispatcher&& dispatcher) const
{
std::vector<CallbackPtr> callbacks;
{
std::lock_guard<std::mutex> lock(m_mutex);
callbacks = m_callbacks;
}
for (const CallbackPtr& callback : callbacks)
dispatcher(*callback);
}
private:
mutable std::mutex m_mutex;
std::vector<CallbackPtr> m_callbacks;
};
} // namespace Slic3r

View File

@@ -1429,7 +1429,7 @@ void PluginLoader::unload_cloud_plugins()
void PluginLoader::run_on_load_callbacks(const std::string& plugin_key)
{
for (auto& fn : m_callbacks[CallbackType::Load]) {
m_load_callbacks.dispatch([&plugin_key](const PluginLifecycleCompleteFn& fn) {
try {
fn(plugin_key);
} catch (const std::exception& ex) {
@@ -1437,12 +1437,12 @@ void PluginLoader::run_on_load_callbacks(const std::string& plugin_key)
} catch (...) {
BOOST_LOG_TRIVIAL(error) << "Plugin load completion callback failed for " << plugin_key;
}
}
});
}
void PluginLoader::run_on_unload_callbacks(const std::string& plugin_key)
{
for (auto& fn : m_callbacks[CallbackType::Unload]) {
m_unload_callbacks.dispatch([&plugin_key](const PluginLifecycleCompleteFn& fn) {
try {
fn(plugin_key);
} catch (const std::exception& ex) {
@@ -1450,12 +1450,12 @@ void PluginLoader::run_on_unload_callbacks(const std::string& plugin_key)
} catch (...) {
BOOST_LOG_TRIVIAL(error) << "Plugin unload completion callback failed for " << plugin_key << ": unknown error";
}
}
});
}
void PluginLoader::run_on_capability_load_callbacks(const PluginCapabilityIdentifier& id)
{
for (auto& fn : m_capability_callbacks[CallbackType::Load]) {
m_capability_load_callbacks.dispatch([&id](const CapabilityLifecycleFn& fn) {
try {
fn(id);
} catch (const std::exception& ex) {
@@ -1465,12 +1465,12 @@ void PluginLoader::run_on_capability_load_callbacks(const PluginCapabilityIdenti
BOOST_LOG_TRIVIAL(error) << "Plugin capability load callback failed for " << id.plugin_key << "/"
<< id.name << ": unknown error";
}
}
});
}
void PluginLoader::run_on_capability_unload_callbacks(const PluginCapabilityIdentifier& id)
{
for (auto& fn : m_capability_callbacks[CallbackType::Unload]) {
m_capability_unload_callbacks.dispatch([&id](const CapabilityLifecycleFn& fn) {
try {
fn(id);
} catch (const std::exception& ex) {
@@ -1480,27 +1480,27 @@ void PluginLoader::run_on_capability_unload_callbacks(const PluginCapabilityIden
BOOST_LOG_TRIVIAL(error) << "Plugin capability unload callback failed for " << id.plugin_key << "/"
<< id.name << ": unknown error";
}
}
});
}
void PluginLoader::subscribe_on_load_callback(PluginLifecycleCompleteFn fn)
{
m_callbacks[CallbackType::Load].push_back(std::move(fn));
m_load_callbacks.subscribe(std::move(fn));
}
void PluginLoader::subscribe_on_unload_callback(PluginLifecycleCompleteFn fn)
{
m_callbacks[CallbackType::Unload].push_back(std::move(fn));
m_unload_callbacks.subscribe(std::move(fn));
}
void PluginLoader::subscribe_on_capability_load_callback(CapabilityLifecycleFn fn)
{
m_capability_callbacks[CallbackType::Load].push_back(std::move(fn));
m_capability_load_callbacks.subscribe(std::move(fn));
}
void PluginLoader::subscribe_on_capability_unload_callback(CapabilityLifecycleFn fn)
{
m_capability_callbacks[CallbackType::Unload].push_back(std::move(fn));
m_capability_unload_callbacks.subscribe(std::move(fn));
}
} // namespace Slic3r

View File

@@ -1,5 +1,6 @@
#pragma once
#include "PluginCallbackList.hpp"
#include "PluginDescriptor.hpp"
#include <boost/filesystem/path.hpp>
@@ -197,8 +198,10 @@ private:
mutable std::mutex m_mutex;
mutable std::condition_variable m_plugin_load_cv;
std::unordered_map<CallbackType, std::vector<PluginLifecycleCompleteFn>> m_callbacks{};
std::unordered_map<CallbackType, std::vector<CapabilityLifecycleFn>> m_capability_callbacks{};
PluginCallbackList<void(const std::string&)> m_load_callbacks;
PluginCallbackList<void(const std::string&)> m_unload_callbacks;
PluginCallbackList<void(const PluginCapabilityIdentifier&)> m_capability_load_callbacks;
PluginCallbackList<void(const PluginCapabilityIdentifier&)> m_capability_unload_callbacks;
/*
callbacks: