From 1ec7de1b5760b5fc1ebda1d244784e3bc4596eb1 Mon Sep 17 00:00:00 2001
From: "Andrew A. de Laix" <alain@lindenlab.com>
Date: Tue, 29 Jun 2010 14:51:26 -0700
Subject: [PATCH] Generate windows minidump files on crash for developer (not
 release for download) builds.  SL crash reporter still enabled.

---
 indra/llcommon/llapp.cpp           |   4 +
 indra/newview/CMakeLists.txt       |   2 +
 indra/newview/llappviewer.cpp      |   2 +-
 indra/newview/llappviewerwin32.cpp |   8 ++
 indra/newview/llwindebug.cpp       | 188 +++++++++++++++++++++++++++++
 indra/newview/llwindebug.h         |  49 ++++++++
 6 files changed, 252 insertions(+), 1 deletion(-)
 create mode 100644 indra/newview/llwindebug.cpp
 create mode 100644 indra/newview/llwindebug.h

diff --git a/indra/llcommon/llapp.cpp b/indra/llcommon/llapp.cpp
index 0447ca93f5c..8f2fe6c26ec 100644
--- a/indra/llcommon/llapp.cpp
+++ b/indra/llcommon/llapp.cpp
@@ -920,6 +920,10 @@ bool windows_post_minidump_callback(const wchar_t* dump_path,
 		ms_sleep(10);
 	}
 
+#ifndef LL_RELEASE_FOR_DOWNLOAD
+	return false;
+#else
 	return true;
+#endif
 }
 #endif
diff --git a/indra/newview/CMakeLists.txt b/indra/newview/CMakeLists.txt
index ce42cb60381..92f701551b5 100644
--- a/indra/newview/CMakeLists.txt
+++ b/indra/newview/CMakeLists.txt
@@ -1150,10 +1150,12 @@ endif (LINUX)
 if (WINDOWS)
     list(APPEND viewer_SOURCE_FILES
          llappviewerwin32.cpp
+         llwindebug.cpp
          )
 
     list(APPEND viewer_HEADER_FILES
          llappviewerwin32.h
+         llwindebug.h
          )
 
     # precompiled header configuration
diff --git a/indra/newview/llappviewer.cpp b/indra/newview/llappviewer.cpp
index 1ed63555b07..1b5b73e3dd7 100644
--- a/indra/newview/llappviewer.cpp
+++ b/indra/newview/llappviewer.cpp
@@ -4133,7 +4133,7 @@ void LLAppViewer::forceErrorBreakpoint()
 void LLAppViewer::forceErrorBadMemoryAccess()
 {
     S32* crash = NULL;
-    *crash = 0xDEADBEEF;
+    *crash = 0xDEADBEEF;  
     return;
 }
 
diff --git a/indra/newview/llappviewerwin32.cpp b/indra/newview/llappviewerwin32.cpp
index e3ef04d03d6..8c9fd09dcbd 100644
--- a/indra/newview/llappviewerwin32.cpp
+++ b/indra/newview/llappviewerwin32.cpp
@@ -64,6 +64,10 @@
 #include "llcommandlineparser.h"
 #include "lltrans.h"
 
+#ifndef LL_RELEASE_FOR_DOWNLOAD
+#include "llwindebug.h"
+#endif
+
 // *FIX:Mani - This hack is to fix a linker issue with libndofdev.lib
 // The lib was compiled under VS2005 - in VS2003 we need to remap assert
 #ifdef LL_DEBUG
@@ -342,6 +346,10 @@ bool LLAppViewerWin32::init()
 	llinfos << "Turning off Windows error reporting." << llendl;
 	disableWinErrorReporting();
 
+#ifndef LL_RELEASE_FOR_DOWNLOAD
+	LLWinDebug::instance().init();
+#endif
+
 	return LLAppViewer::init();
 }
 
diff --git a/indra/newview/llwindebug.cpp b/indra/newview/llwindebug.cpp
new file mode 100644
index 00000000000..ba33a56ad08
--- /dev/null
+++ b/indra/newview/llwindebug.cpp
@@ -0,0 +1,188 @@
+/** 
+ * @file llwindebug.cpp
+ * @brief Windows debugging functions
+ *
+ * $LicenseInfo:firstyear=2004&license=viewergpl$
+ * 
+ * Copyright (c) 2004-2009, Linden Research, Inc.
+ * 
+ * Second Life Viewer Source Code
+ * The source code in this file ("Source Code") is provided by Linden Lab
+ * to you under the terms of the GNU General Public License, version 2.0
+ * ("GPL"), unless you have obtained a separate licensing agreement
+ * ("Other License"), formally executed by you and Linden Lab.  Terms of
+ * the GPL can be found in doc/GPL-license.txt in this distribution, or
+ * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
+ * 
+ * There are special exceptions to the terms and conditions of the GPL as
+ * it is applied to this Source Code. View the full text of the exception
+ * in the file doc/FLOSS-exception.txt in this software distribution, or
+ * online at
+ * http://secondlifegrid.net/programs/open_source/licensing/flossexception
+ * 
+ * By copying, modifying or distributing this software, you acknowledge
+ * that you have read and understood your obligations described above,
+ * and agree to abide by those obligations.
+ * 
+ * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
+ * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
+ * COMPLETENESS OR PERFORMANCE.
+ * $/LicenseInfo$
+ */
+#include "llviewerprecompiledheaders.h"
+
+#include "llwindebug.h"
+#include "lldir.h"
+
+
+// based on dbghelp.h
+typedef BOOL (WINAPI *MINIDUMPWRITEDUMP)(HANDLE hProcess, DWORD dwPid, HANDLE hFile, MINIDUMP_TYPE DumpType,
+									CONST PMINIDUMP_EXCEPTION_INFORMATION ExceptionParam,
+									CONST PMINIDUMP_USER_STREAM_INFORMATION UserStreamParam,
+									CONST PMINIDUMP_CALLBACK_INFORMATION CallbackParam
+									);
+
+MINIDUMPWRITEDUMP f_mdwp = NULL;
+
+
+class LLMemoryReserve {
+public:
+	LLMemoryReserve();
+	~LLMemoryReserve();
+	void reserve();
+	void release();
+protected:
+	unsigned char *mReserve;
+	static const size_t MEMORY_RESERVATION_SIZE;
+};
+
+LLMemoryReserve::LLMemoryReserve() :
+	mReserve(NULL)
+{
+};
+
+LLMemoryReserve::~LLMemoryReserve()
+{
+	release();
+}
+
+// I dunno - this just seemed like a pretty good value.
+const size_t LLMemoryReserve::MEMORY_RESERVATION_SIZE = 5 * 1024 * 1024;
+
+void LLMemoryReserve::reserve()
+{
+	if(NULL == mReserve)
+		mReserve = new unsigned char[MEMORY_RESERVATION_SIZE];
+};
+
+void LLMemoryReserve::release()
+{
+	delete [] mReserve;
+	mReserve = NULL;
+};
+
+static LLMemoryReserve gEmergencyMemoryReserve;
+
+
+LONG NTAPI vectoredHandler(PEXCEPTION_POINTERS exception_infop)
+{
+	LLWinDebug::instance().generateMinidump(exception_infop);
+	return EXCEPTION_CONTINUE_SEARCH;
+}
+
+// static
+void  LLWinDebug::init()
+{
+	static bool s_first_run = true;
+	// Load the dbghelp dll now, instead of waiting for the crash.
+	// Less potential for stack mangling
+
+	if (s_first_run)
+	{
+		// First, try loading from the directory that the app resides in.
+		std::string local_dll_name = gDirUtilp->findFile("dbghelp.dll", gDirUtilp->getWorkingDir(), gDirUtilp->getExecutableDir());
+
+		HMODULE hDll = NULL;
+		hDll = LoadLibraryA(local_dll_name.c_str());
+		if (!hDll)
+		{
+			hDll = LoadLibrary(L"dbghelp.dll");
+		}
+
+		if (!hDll)
+		{
+			LL_WARNS("AppInit") << "Couldn't find dbghelp.dll!" << LL_ENDL;
+		}
+		else
+		{
+			f_mdwp = (MINIDUMPWRITEDUMP) GetProcAddress(hDll, "MiniDumpWriteDump");
+
+			if (!f_mdwp)
+			{
+				FreeLibrary(hDll);
+				hDll = NULL;
+			}
+		}
+
+		gEmergencyMemoryReserve.reserve();
+
+		s_first_run = false;
+
+		// Add this exeption hanlder to save windows style minidump.
+		AddVectoredExceptionHandler(0, &vectoredHandler);
+	}
+}
+
+void LLWinDebug::writeDumpToFile(MINIDUMP_TYPE type, MINIDUMP_EXCEPTION_INFORMATION *ExInfop, const std::string& filename)
+{
+	if(f_mdwp == NULL || gDirUtilp == NULL) 
+	{
+		return;
+	}
+	else
+	{
+		std::string dump_path = gDirUtilp->getExpandedFilename(LL_PATH_LOGS, filename);
+
+		HANDLE hFile = CreateFileA(dump_path.c_str(),
+									GENERIC_WRITE,
+									FILE_SHARE_WRITE,
+									NULL,
+									CREATE_ALWAYS,
+									FILE_ATTRIBUTE_NORMAL,
+									NULL);
+
+		if (hFile != INVALID_HANDLE_VALUE)
+		{
+			// Write the dump, ignoring the return value
+			f_mdwp(GetCurrentProcess(),
+					GetCurrentProcessId(),
+					hFile,
+					type,
+					ExInfop,
+					NULL,
+					NULL);
+
+			CloseHandle(hFile);
+		}
+
+	}
+}
+
+// static
+void LLWinDebug::generateMinidump(struct _EXCEPTION_POINTERS *exception_infop)
+{
+	std::string dump_path = gDirUtilp->getExpandedFilename(LL_PATH_LOGS,
+												"SecondLifeException");
+	if (exception_infop)
+	{
+		// Since there is exception info... Release the hounds.
+		gEmergencyMemoryReserve.release();
+
+		_MINIDUMP_EXCEPTION_INFORMATION ExInfo;
+
+		ExInfo.ThreadId = ::GetCurrentThreadId();
+		ExInfo.ExceptionPointers = exception_infop;
+		ExInfo.ClientPointers = NULL;
+		writeDumpToFile((MINIDUMP_TYPE)(MiniDumpWithDataSegs | MiniDumpWithIndirectlyReferencedMemory), &ExInfo, "SecondLife.dmp");
+	}
+}
diff --git a/indra/newview/llwindebug.h b/indra/newview/llwindebug.h
new file mode 100644
index 00000000000..809d1b8cc35
--- /dev/null
+++ b/indra/newview/llwindebug.h
@@ -0,0 +1,49 @@
+/** 
+ * @file llwindebug.h
+ * @brief LLWinDebug class header file
+ *
+ * $LicenseInfo:firstyear=2004&license=viewergpl$
+ * 
+ * Copyright (c) 2004-2009, Linden Research, Inc.
+ * 
+ * Second Life Viewer Source Code
+ * The source code in this file ("Source Code") is provided by Linden Lab
+ * to you under the terms of the GNU General Public License, version 2.0
+ * ("GPL"), unless you have obtained a separate licensing agreement
+ * ("Other License"), formally executed by you and Linden Lab.  Terms of
+ * the GPL can be found in doc/GPL-license.txt in this distribution, or
+ * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
+ * 
+ * There are special exceptions to the terms and conditions of the GPL as
+ * it is applied to this Source Code. View the full text of the exception
+ * in the file doc/FLOSS-exception.txt in this software distribution, or
+ * online at
+ * http://secondlifegrid.net/programs/open_source/licensing/flossexception
+ * 
+ * By copying, modifying or distributing this software, you acknowledge
+ * that you have read and understood your obligations described above,
+ * and agree to abide by those obligations.
+ * 
+ * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
+ * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
+ * COMPLETENESS OR PERFORMANCE.
+ * $/LicenseInfo$
+ */
+
+#ifndef LL_LLWINDEBUG_H
+#define LL_LLWINDEBUG_H
+
+#include "stdtypes.h"
+#include <dbghelp.h>
+
+class LLWinDebug:
+	public LLSingleton<LLWinDebug>
+{
+public:
+	static void init();
+	static void generateMinidump(struct _EXCEPTION_POINTERS *pExceptionInfo = NULL);
+private:
+	static void writeDumpToFile(MINIDUMP_TYPE type, MINIDUMP_EXCEPTION_INFORMATION *ExInfop, const std::string& filename);
+};
+
+#endif // LL_LLWINDEBUG_H
-- 
GitLab