mirror
/
openmw
mirror of https://github.com/OpenMW/openmw.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge branch 'no-crash-dump-in-temp-0.48' into 'openmw-48'

Browse Source 
Don't put crash dumps in Temp on Windows

See merge request OpenMW/openmw!3199
openmw-48
psi29a 11 months ago
parent 3364d9a2d6 5102f4b11d
commit 99c07153e7
6 changed files with 81 additions and 19 deletions
Show Stats Download Patch File Download Diff File

41
components/crashcatcher/windows_crashcatcher.cpp
Unescape Escape View File

@ -26,7 +26,7 @@ namespace Crash
CrashCatcher* CrashCatcher::sInstance = nullptr;
CrashCatcher::CrashCatcher(int argc, char **argv, const std::string& crashLogPath)
CrashCatcher::CrashCatcher(int argc, char** argv, const std::string& crashDumpPath, const std::string& freezeDumpPath)
{
assert(sInstance == nullptr); // don't allow two instances
@ -48,7 +48,7 @@ namespace Crash
if (!shmHandle)
{
setupIpc();
startMonitorProcess(crashLogPath);
startMonitorProcess(crashDumpPath, freezeDumpPath);
installHandler();
}
else
@ -75,6 +75,25 @@ namespace Crash
CloseHandle(mShmHandle);
}
void CrashCatcher::updateDumpPaths(const std::string& crashDumpPath, const std::string& freezeDumpPath)
{
shmLock();
memset(mShm->mStartup.mCrashDumpFilePath, 0, sizeof(mShm->mStartup.mCrashDumpFilePath));
size_t length = crashDumpPath.length();
if (length >= MAX_LONG_PATH) length = MAX_LONG_PATH - 1;
strncpy(mShm->mStartup.mCrashDumpFilePath, crashDumpPath.c_str(), length);
mShm->mStartup.mCrashDumpFilePath[length] = '\0';
memset(mShm->mStartup.mFreezeDumpFilePath, 0, sizeof(mShm->mStartup.mFreezeDumpFilePath));
length = freezeDumpPath.length();
if (length >= MAX_LONG_PATH) length = MAX_LONG_PATH - 1;
strncpy(mShm->mStartup.mFreezeDumpFilePath, freezeDumpPath.c_str(), length);
mShm->mStartup.mFreezeDumpFilePath[length] = '\0';
shmUnlock();
}
void CrashCatcher::setupIpc()
{
SECURITY_ATTRIBUTES attributes;
@ -124,7 +143,7 @@ namespace Crash
SetUnhandledExceptionFilter(vectoredExceptionHandler);
}
void CrashCatcher::startMonitorProcess(const std::string& crashLogPath)
void CrashCatcher::startMonitorProcess(const std::string& crashDumpPath, const std::string& freezeDumpPath)
{
std::wstring executablePath;
DWORD copied = 0;
@ -134,11 +153,17 @@ namespace Crash
} while (copied >= executablePath.size());
executablePath.resize(copied);
memset(mShm->mStartup.mLogFilePath, 0, sizeof(mShm->mStartup.mLogFilePath));
size_t length = crashLogPath.length();
memset(mShm->mStartup.mCrashDumpFilePath, 0, sizeof(mShm->mStartup.mCrashDumpFilePath));
size_t length = crashDumpPath.length();
if (length >= MAX_LONG_PATH) length = MAX_LONG_PATH - 1;
strncpy(mShm->mStartup.mCrashDumpFilePath, crashDumpPath.c_str(), length);
mShm->mStartup.mCrashDumpFilePath[length] = '\0';
memset(mShm->mStartup.mFreezeDumpFilePath, 0, sizeof(mShm->mStartup.mFreezeDumpFilePath));
length = freezeDumpPath.length();
if (length >= MAX_LONG_PATH) length = MAX_LONG_PATH - 1;
strncpy(mShm->mStartup.mLogFilePath, crashLogPath.c_str(), length);
mShm->mStartup.mLogFilePath[length] = '\0';
strncpy(mShm->mStartup.mFreezeDumpFilePath, freezeDumpPath.c_str(), length);
mShm->mStartup.mFreezeDumpFilePath[length] = '\0';
// note that we don't need to lock the SHM here, the other process has not started yet
mShm->mEvent = CrashSHM::Event::Startup;
@ -197,7 +222,7 @@ namespace Crash
// must remain until monitor has finished
waitMonitor();
std::string message = "OpenMW has encountered a fatal error.\nCrash log saved to '" + std::string(mShm->mStartup.mLogFilePath) + "'.\nPlease report this to https://gitlab.com/OpenMW/openmw/issues !";
std::string message = "OpenMW has encountered a fatal error.\nCrash log saved to '" + std::string(mShm->mStartup.mCrashDumpFilePath) + "'.\nPlease report this to https://gitlab.com/OpenMW/openmw/issues !";
SDL_ShowSimpleMessageBox(0, "Fatal Error", message.c_str(), nullptr);
}

10
components/crashcatcher/windows_crashcatcher.hpp
Unescape Escape View File

@ -27,10 +27,16 @@ namespace Crash
class CrashCatcher final
{
public:
static CrashCatcher* instance()
{
return sInstance;
}
CrashCatcher(int argc, char **argv, const std::string& crashLogPath);
CrashCatcher(int argc, char** argv, const std::string& crashDumpPath, const std::string& freezeDumpPath);
~CrashCatcher();
void updateDumpPaths(const std::string& crashDumpPath, const std::string& freezeDumpPath);
private:
static CrashCatcher* sInstance;
@ -56,7 +62,7 @@ namespace Crash
void shmUnlock();
void startMonitorProcess(const std::string& crashLogPath);
void startMonitorProcess(const std::string& crashDumpPath, const std::string& freezeDumpPath);
void waitMonitor();

10
components/crashcatcher/windows_crashmonitor.cpp
Unescape Escape View File

@ -186,7 +186,7 @@ namespace Crash
case CrashSHM::Event::None:
break;
case CrashSHM::Event::Crashed:
handleCrash();
handleCrash(false);
running = false;
break;
case CrashSHM::Event::Shutdown:
@ -205,9 +205,9 @@ namespace Crash
if (mFreezeAbort)
{
handleCrash();
handleCrash(true);
TerminateProcess(mAppProcessHandle, 0xDEAD);
std::string message = "OpenMW appears to have frozen.\nCrash log saved to '" + std::string(mShm->mStartup.mLogFilePath) + "'.\nPlease report this to https://gitlab.com/OpenMW/openmw/issues !";
std::string message = "OpenMW appears to have frozen.\nCrash log saved to '" + std::string(mShm->mStartup.mFreezeDumpFilePath) + "'.\nPlease report this to https://gitlab.com/OpenMW/openmw/issues !";
SDL_ShowSimpleMessageBox(0, "Fatal Error", message.c_str(), nullptr);
}
@ -231,7 +231,7 @@ namespace Crash
return utf16;
}
void CrashMonitor::handleCrash()
void CrashMonitor::handleCrash(bool isFreeze)
{
DWORD processId = GetProcessId(mAppProcessHandle);
@ -250,7 +250,7 @@ namespace Crash
if (miniDumpWriteDump == NULL)
return;
std::wstring utf16Path = utf8ToUtf16(mShm->mStartup.mLogFilePath);
std::wstring utf16Path = utf8ToUtf16(isFreeze ? mShm->mStartup.mFreezeDumpFilePath : mShm->mStartup.mCrashDumpFilePath);
if (utf16Path.empty())
return;

2
components/crashcatcher/windows_crashmonitor.hpp
Unescape Escape View File

@ -53,7 +53,7 @@ private:
void shmUnlock();
void handleCrash();
void handleCrash(bool isFreeze);
void showFreezeMessageBox();

3
components/crashcatcher/windows_crashshm.hpp
Unescape Escape View File

@ -28,7 +28,8 @@ namespace Crash
HANDLE mSignalApp;
HANDLE mSignalMonitor;
HANDLE mShmMutex;
char mLogFilePath[MAX_LONG_PATH];
char mCrashDumpFilePath[MAX_LONG_PATH];
char mFreezeDumpFilePath[MAX_LONG_PATH];
} mStartup;
struct Crashed

34
components/debug/debugging.cpp
Unescape Escape View File

@ -9,6 +9,18 @@
#ifdef _WIN32
#include <components/crashcatcher/windows_crashcatcher.hpp>
#include <components/windows.hpp>
#include <Knownfolders.h>
#pragma push_macro("FAR")
#pragma push_macro("NEAR")
#undef FAR
#define FAR
#undef NEAR
#define NEAR
#include <Shlobj.h>
#pragma pop_macro("NEAR")
#pragma pop_macro("FAR")
#endif
#include <SDL_messagebox.h>
@ -284,6 +296,16 @@ void setupLogging(const std::string& logDir, std::string_view appName)
std::cout.rdbuf(&coutsb);
std::cerr.rdbuf(&cerrsb);
#endif
#ifdef _WIN32
if (Crash::CrashCatcher::instance())
{
const std::string crashDumpName = Misc::StringUtils::lowerCase(appName) + "-crash.dmp";
const std::string freezeDumpName = Misc::StringUtils::lowerCase(appName) + "-freeze.dmp";
boost::filesystem::path dumpDirectory(logDir);
Crash::CrashCatcher::instance()->updateDumpPaths((dumpDirectory / crashDumpName).make_preferred().string(), (dumpDirectory / freezeDumpName).make_preferred().string());
}
#endif
}
int wrapApplication(int (*innerApplication)(int argc, char *argv[]), int argc, char *argv[],
@ -304,8 +326,16 @@ int wrapApplication(int (*innerApplication)(int argc, char *argv[]), int argc, c
if (const auto env = std::getenv("OPENMW_DISABLE_CRASH_CATCHER"); env == nullptr || std::atol(env) == 0)
{
#if defined(_WIN32)
const std::string crashLogName = Misc::StringUtils::lowerCase(appName) + "-crash.dmp";
Crash::CrashCatcher crashy(argc, argv, (boost::filesystem::temp_directory_path() / crashLogName).make_preferred().string());
const std::string crashDumpName = Misc::StringUtils::lowerCase(appName) + "-crash.dmp";
const std::string freezeDumpName = Misc::StringUtils::lowerCase(appName) + "-freeze.dmp";
boost::filesystem::path dumpDirectory = boost::filesystem::temp_directory_path();
PWSTR userProfile = nullptr;
if (SUCCEEDED(SHGetKnownFolderPath(FOLDERID_Profile, 0, nullptr, &userProfile)))
{
dumpDirectory = userProfile;
}
CoTaskMemFree(userProfile);
Crash::CrashCatcher crashy(argc, argv, (dumpDirectory / crashDumpName).make_preferred().string(), (dumpDirectory / freezeDumpName).make_preferred().string());
#else
const std::string crashLogName = Misc::StringUtils::lowerCase(appName) + "-crash.log";
// install the crash handler as soon as possible. note that the log path

Write Preview
Loading…
Cancel
Save