Implement pfCrashHandler

pfCrashHandler includes a client that watches plClient for crashes. When it detects a crash, it lets the plCrashSrv (plCrashHandler.exe) know about it. We then produce a mninidump, then signal the client that it's OK to show a crash dialog. See http://www.nynaeve.net/?p=128 for a good explanation of why I split the crash logic into another process.
2025-07-20 20:29:10 +00:00 · 2012-03-29 21:17:26 -04:00
parent 43b9535e96
commit 14279794f7
15 changed files with 765 additions and 55 deletions
--- a/Sources/Plasma/FeatureLib/pfCrashHandler/plCrashSrv.cpp
+++ b/Sources/Plasma/FeatureLib/pfCrashHandler/plCrashSrv.cpp
@ -0,0 +1,117 @@
+/*==LICENSE==*
+
+CyanWorlds.com Engine - MMOG client, server and tools
+Copyright (C) 2011  Cyan Worlds, Inc.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Additional permissions under GNU GPL version 3 section 7
+
+If you modify this Program, or any covered work, by linking or
+combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK,
+NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent
+JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK
+(or a modified version of those libraries),
+containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA,
+PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG
+JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the
+licensors of this Program grant you additional
+permission to convey the resulting work. Corresponding Source for a
+non-source form of such a combination shall include the source code for
+the parts of OpenSSL and IJG JPEG Library used as well as that of the covered
+work.
+
+You can contact Cyan Worlds, Inc. by email legal@cyan.com
+ or by snail mail at:
+      Cyan Worlds, Inc.
+      14617 N Newport Hwy
+      Mead, WA   99021
+
+*==LICENSE==*/
+
+#include "plCrashSrv.h"
+#include "plCrash_Private.h"
+#include "plFile/plFileUtils.h"
+#include "pnProduct/pnProduct.h"
+
+#ifdef HS_BUILD_FOR_WIN32
+
+#include <DbgHelp.h>
+#include <ShlObj.h>
+
+plCrashSrv::plCrashSrv(const char* file)
+    : fLink(nil), fLinkH(nil)
+{
+    // Init semas
+    IInit(file);
+
+    // Open the linked memory
+    fLinkH = OpenFileMappingA(FILE_MAP_ALL_ACCESS, FALSE, file);
+    hsAssert(fLinkH, "Failed to open plCrashHandler mapping");
+    if (!fLinkH)
+        return;
+
+    // Try to map it
+    fLink = (plCrashMemLink*)MapViewOfFile(fLinkH, FILE_MAP_ALL_ACCESS, 0, 0, sizeof(plCrashMemLink));
+    hsAssert(fLink, "Failed to map plCrashMemLink");
+}
+
+plCrashSrv::~plCrashSrv()
+{
+    if (fLink)
+        UnmapViewOfFile((LPCVOID)fLink);
+    if (fLinkH)
+        CloseHandle(fLinkH);
+}
+
+void plCrashSrv::IHandleCrash()
+{
+    // Begin Hackiness
+    wchar_t dumpPath[1024];
+    SHGetSpecialFolderPathW(NULL, dumpPath, CSIDL_LOCAL_APPDATA, TRUE);
+    plFileUtils::ConcatFileName(dumpPath, ProductLongName());
+    plFileUtils::ConcatFileName(dumpPath, L"Log");
+    plFileUtils::EnsureFilePathExists(dumpPath);
+    plFileUtils::ConcatFileName(dumpPath, L"crash.dmp");
+    HANDLE file = CreateFileW(dumpPath,
+                              GENERIC_WRITE,
+                              0,
+                              NULL,
+                              CREATE_ALWAYS,
+                              FILE_ATTRIBUTE_NORMAL,
+                              NULL
+    );
+    // End Hackiness
+
+    MINIDUMP_EXCEPTION_INFORMATION e;
+    e.ClientPointers = TRUE;
+    e.ExceptionPointers = fLink->fExceptionPtrs;
+    e.ThreadId = fLink->fClientThreadID;
+    MiniDumpWriteDump(fLink->fClientProcess, fLink->fClientProcessID, file, MiniDumpNormal, &e, NULL, NULL);
+    CloseHandle(file);
+}
+
+#else
+#   error "Implement plCrashSrv for this platform"
+#endif
+
+void plCrashSrv::HandleCrash()
+{
+    fCrashed->Wait(); // Wait for a crash
+    if (!fLink)
+        FATAL("plCrashMemLink is nil!");
+    else if (fLink->fCrashed)
+        IHandleCrash();
+    fHandled->Signal(); // Tell CrashCli we handled it
+}