muskit/spice2x.github.io
0
0
Fork 0
mirror of https://github.com/spice2x/spice2x.github.io.git synced 2026-08-02 06:40:42 -07:00
Code Issues Packages Projects Releases Wiki Activity

troubleshooter: properly fix deadlock (#395)

Browse Source 
## Description of change
Finally figured out where the deadlock was coming from - it's because
the `dump_to_logger` was writing `SuperstepSound: Audio device is not
available` to the logger which calls back into the log hook, and then
emits another deferred message, trying to acquire the lock again on the
same stack.

## Testing
Tested the superstep sound failure case again.
This commit is contained in:
bicarus-dev
2025-10-04 13:50:04 -07:00
committed by GitHub
parent 8d3b15641f
commit 8e2985d8d0
3 changed files with 26 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/spice2x/util/deferlog.cpp
+23 -14
View File
@@ -8,7 +8,6 @@ namespace deferredlogs {
const std::initializer_list<std::string> SUPERSTEP_SOUND_ERROR_MESSAGE = {
"audio initialization error was previously detected during boot!",
" (W:SuperstepSound: Audio device is not available!!!)",
" this crash is most likely related to audio init failure",
" * check if the default audio device has changed",
" * fix your audio device settings (e.g., sample rate)",
@@ -17,37 +16,47 @@ namespace deferredlogs {
std::mutex deferred_errors_mutex;
std::vector<std::vector<std::string>> deferred_errors;
std::atomic<bool> too_late;
void defer_error_messages(std::initializer_list<std::string> messages) {
// don't try to acquire lock if already dumping to logger
if (too_late) {
return;
}
std::lock_guard<std::mutex> lock(deferred_errors_mutex);
deferred_errors.emplace_back(messages);
}
void dump_to_logger() {
void dump_to_logger(bool is_crash) {
static std::once_flag printed;
std::call_once(printed, []() {
too_late = true;
if (deferred_errors.empty()) {
return;
std::call_once(printed, [is_crash]() {
// move to a local vector under lock first
// this is to avoid holding a lock while emitting to the logger, which may deadlock
// due to recursive calls (e.g., via log hooks used for failure detection which then
// again calls into defer_error_messages), and std::mutex cannot be acquired recursively
std::vector<std::vector<std::string>> errors;
{
std::lock_guard<std::mutex> lock(deferred_errors_mutex);
if (deferred_errors.empty() && !is_crash) {
return;
}
errors = std::move(deferred_errors);
}
log_warning("troubleshooter", "/------------------------ spice2x auto-troubleshooter ------------------------\\");
log_warning("troubleshooter", "");
if (is_crash) {
log_warning("troubleshooter", " the game has crashed");
log_warning("troubleshooter", " share this entire log file with someone for troubleshooting");
log_warning("troubleshooter", " spice will also attempt to create a minidump (minidump.dmp)");
log_warning("troubleshooter", "");
}
for (auto messages : deferred_errors) {
for (auto messages : errors) {
for (auto message : messages) {
log_warning("troubleshooter", " {}", message);
}
log_warning("troubleshooter", "");
}
log_warning("troubleshooter", " Still unsure? Check the FAQ:");
log_warning("troubleshooter", " unsure what to do next? check the FAQ:");
log_warning("troubleshooter", " https://github.com/spice2x/spice2x.github.io/wiki/Known-issues");
log_warning("troubleshooter", "");
log_warning("troubleshooter", "\\------------------------ spice2x auto-troubleshooter -----------------------/");