Save a Memory Dump for debugging Crashes - Revision history

Stgatilov: Cleaning the GDB section

2025-04-12T00:00:39Z

Cleaning the GDB section

← Older revision		Revision as of 00:00, 12 April 2025
Line 98:		Line 98:

	Unfortunately, sometimes core dump alone is not enough to inspect the crash on the other machine.		Unfortunately, sometimes core dump alone is not enough to inspect the crash on the other machine.
	~~Sometimes the~~ system binaries ~~are also necessary~~ to properly decipher stack trace.		A developer might need some system binaries in order to properly decipher stack trace.
	The following libraries are necessary sometimes:		The following libraries are known to be necessary sometimes:
	* <tt>libc</tt>		* <tt>libc</tt>
	* <tt>libpthread</tt>		* <tt>libpthread</tt>
	* <tt>libthread_db</tt>		* <tt>libthread_db</tt>

	These files ~~can be~~ named something like <tt>~~libthread_db~~.so.1</tt>, <tt>libc.so.6</tt>, <tt>~~libc-2~~.26.so</tt> and be located in <tt>/lib/x86_64-linux-gnu</tt>		These files are usually named something like <tt>libpthread-2.26.so</tt>, <tt>libc-2.26.so</tt>, <tt>libthread_db.so.1</tt> and are located in <tt>/lib/x86_64-linux-gnu</tt>.
	~~Before~~ of symlinks! The developer needs the target file with real contents.		Beware of symlinks! The developer needs the target file with real contents.

	See also: [https://forums.thedarkmod.com/index.php?/topic/21060-mission-downloader-issue "Mission downloader issue" on the forum].		See also: [https://forums.thedarkmod.com/index.php?/topic/21060-mission-downloader-issue "Mission downloader issue" on the forum]

	[[Category:DarkRadiant]]		[[Category:DarkRadiant]]
	[[Category:Coding]]		[[Category:Coding]]

Stgatilov: More info about Linux core dumps.

2025-04-11T19:32:42Z

More info about Linux core dumps.

← Older revision		Revision as of 19:32, 11 April 2025
Line 84:		Line 84:

	Make sure GDB is installed. Usually it is installed by default.		Make sure GDB is installed. Usually it is installed by default.

			[[File:Coredump-_start_gdb.png\|thumb]]
			[[File:Coredump-_save_core_dump.png\|thumb]]

	# Run the game under GDB: <tt>gdb ./thedarkmod.x64</tt>		# Run the game under GDB: <tt>gdb ./thedarkmod.x64</tt>
Line 89:		Line 92:
	# When the game crashes, gdb will most likely break.		# When the game crashes, gdb will most likely break.
	# Record core dump with a command: <tt>generate-core-file</tt>		# Record core dump with a command: <tt>generate-core-file</tt>
	# ~~TODO: where~~ is the ~~dump?~~		# The dump should be in the current directory, usually named like <tt>core.27372</tt>.

			Note that core dumps are pretty large, but they compress well.
			Make sure to put it into zip/gz/whatever before uploading.

			Unfortunately, sometimes core dump alone is not enough to inspect the crash on the other machine.
			Sometimes the system binaries are also necessary to properly decipher stack trace.
			The following libraries are necessary sometimes:
			* <tt>libc</tt>
			* <tt>libpthread</tt>
			* <tt>libthread_db</tt>

	~~TODO: issues~~ with ~~system libraries~~		These files can be named something like <tt>libthread_db.so.1</tt>, <tt>libc.so.6</tt>, <tt>libc-2.26.so</tt> and be located in <tt>/lib/x86_64-linux-gnu</tt>
			Before of symlinks! The developer needs the target file with real contents.

	~~TODO~~: ~~references~~		See also: [https://forums.thedarkmod.com/index.php?/topic/21060-mission-downloader-issue "Mission downloader issue" on the forum].

	[[Category:DarkRadiant]]		[[Category:DarkRadiant]]
	[[Category:Coding]]		[[Category:Coding]]

Stgatilov at 08:18, 11 April 2025

2025-04-11T08:18:59Z

← Older revision		Revision as of 08:18, 11 April 2025
Line 8:		Line 8:
	It is possible to record memory dump of alive process, although in most cases such dump would be useless.<br>		It is possible to record memory dump of alive process, although in most cases such dump would be useless.<br>

	~~<b>Note:</b>~~		= Windows =
	* At the moment this only applies to the Windows ~~OS.<br>~~
	* There is similar mechanism (core dumps) on Linux environments, but it is not covered by this article yet.


	== Enable Memory Dumps ==		== Enable Memory Dumps ==
Line 82:		Line 79:
	In this case, restart Windows instead of starting WerSvc service.<br>		In this case, restart Windows instead of starting WerSvc service.<br>

			= Linux =

			== Record with GDB ==

			Make sure GDB is installed. Usually it is installed by default.

			# Run the game under GDB: <tt>gdb ./thedarkmod.x64</tt>
			# Within GDB, type <tt>run</tt> and hit Enter to start the program.
			# When the game crashes, gdb will most likely break.
			# Record core dump with a command: <tt>generate-core-file</tt>
			# TODO: where is the dump?

			TODO: issues with system libraries

			TODO: references

	[[Category:DarkRadiant]]		[[Category:DarkRadiant]]
	[[Category:Coding]]		[[Category:Coding]]

Bikerdude: /* Enable Memory Dumps */

2024-03-18T20:09:38Z

Enable Memory Dumps

← Older revision		Revision as of 20:09, 18 March 2024
Line 21:		Line 21:
	* Run the Registry Editor		* Run the Registry Editor
	* Find path: <tt>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting</tt>		* Find path: <tt>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting</tt>
	* Create <tt>DWORD</tt> key with name <tt>DontShowUI</tt> and value <tt>0</tt>		* Create <tt>DWORD</tt> (32bit) key with name <tt>DontShowUI</tt> and value <tt>0</tt>

	See alternative method here: https://superuser.com/a/1349113		See alternative method here: https://superuser.com/a/1349113

Freyk: /* Record Memory Dumps automatically (alternative approach) */

2022-09-15T06:16:25Z

Record Memory Dumps automatically (alternative approach)

← Older revision		Revision as of 06:16, 15 September 2022
Line 55:		Line 55:
	== Record Memory Dumps automatically (alternative approach) ==		== Record Memory Dumps automatically (alternative approach) ==

	When the "darkradiant stopped working" popup ~~dont~~ appear,<br>		When the "darkradiant has stopped working" popup doesnt appear, when the program crashes,<br>
	~~Then~~ is possible to enable automatic saving of crash dumps, ~~when particular program crashes.~~<br>		then is possible to enable automatic saving of crash dumps, <br>
	This way is not recommended since it is more complicated to setup.<br>		This way is not recommended since it is more complicated to setup.<br>
	It is also described in [https://docs.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps Windows User-Mode Dumps].		It is also described in [https://docs.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps Windows User-Mode Dumps].

Freyk: /* Record Memory Dumps automatically (alternative approach) */

2022-09-15T06:15:14Z

Record Memory Dumps automatically (alternative approach)

← Older revision		Revision as of 06:15, 15 September 2022
Line 55:		Line 55:
	== Record Memory Dumps automatically (alternative approach) ==		== Record Memory Dumps automatically (alternative approach) ==

	It is possible to enable automatic saving of crash dumps, when particular program crashes.<br>		When the "darkradiant stopped working" popup dont appear,<br>
	This way is not recommended since it is more complicated.<br>		Then is possible to enable automatic saving of crash dumps, when particular program crashes.<br>
			This way is not recommended since it is more complicated to setup.<br>
	It is also described in [https://docs.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps Windows User-Mode Dumps].		It is also described in [https://docs.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps Windows User-Mode Dumps].

Stgatilov at 14:19, 22 January 2022

2022-01-22T14:19:51Z

← Older revision		Revision as of 14:19, 22 January 2022
Line 11:		Line 11:
	* At the moment this only applies to the Windows OS.<br>		* At the moment this only applies to the Windows OS.<br>
	* There is similar mechanism (core dumps) on Linux environments, but it is not covered by this article yet.		* There is similar mechanism (core dumps) on Linux environments, but it is not covered by this article yet.


	== Enable Memory Dumps ==		== Enable Memory Dumps ==

Stgatilov: Moved alternative approach to the very bottom to avoid scaring readers.

2022-01-22T14:19:24Z

Moved alternative approach to the very bottom to avoid scaring readers.

← Older revision		Revision as of 14:19, 22 January 2022
Line 4:		Line 4:
	If a crash is reproducible, it might be enough to describe the exact steps that lead up to the fault and file a bug report on the [http://bugs.thedarkmod.com bugtracker]. <br>		If a crash is reproducible, it might be enough to describe the exact steps that lead up to the fault and file a bug report on the [http://bugs.thedarkmod.com bugtracker]. <br>
	But more often than sometimes crashes occur out of seemingly nothing and are barely reproducible, and in this case a saved memory dump is even more valuable for debugging purposes.		But more often than sometimes crashes occur out of seemingly nothing and are barely reproducible, and in this case a saved memory dump is even more valuable for debugging purposes.
	~~<br>~~
	In principle, recording memory dumps is not limited to crashed applications.<br>		In principle, recording memory dumps is not limited to crashed applications.<br>
	It is possible to record memory dump of alive process, although in most cases such dump would be useless.<br>		It is possible to record memory dump of alive process, although in most cases such dump would be useless.<br>
	~~<br>~~
	~~There a several methods to record a memory dump:~~
	* Record the memory dump manually, when the application is crashing. (see following chapter)
	* Record the memory dump automatically, when the application is crashing. (see chapter: "Alternative approach" on this article)
	~~<br>~~
	<b>Note:</b>		<b>Note:</b>
	* At the moment this only applies to the Windows OS.<br>		* At the moment this only applies to the Windows OS.<br>
	* There is similar mechanism (core dumps) on Linux environments, but it is not covered by this article yet.		* There is similar mechanism (core dumps) on Linux environments, but it is not covered by this article yet.
	~~<br>~~

	== Enable Memory Dumps ==		== Enable Memory Dumps ==
Line 45:		Line 40:
	<br>		<br>

	== ~~Enable~~ and ~~record Memory Dumps automatically (alternative approach)~~ ==		== Compress and upload the dump ==

	It is possible to enable automatic saving of crash dumps, when particular program crashes<br>		Depending on what you had opened in DarkRadiant or what FM you loaded in the game itself, the .dmp file might end up very large,<br>
	~~The process~~ is also described in [https://docs.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps Windows User-Mode Dumps].		so it's best to compress it by right-clicking it and selecting "Send to..." > "Compressed (zip) folder". <br>(Or use 7-zip to compress the file)<br>
			Upload that folder to some place in the web, and please go to the forums to tell the devs about your crash dump.
			<br><br>
			'''Thanks for your time''',<br>we know that recording and uploading crash dumps might be tedious, <br> but without we really can't do much about the crash, so your help is appreciated!

			== Debugging / Analysis ==
			Coders might want to check out the article on [[Analyze_a_Memory_Dump\|analyzing a memory dump.]]


			== Record Memory Dumps automatically (alternative approach) ==

			It is possible to enable automatic saving of crash dumps, when particular program crashes.<br>
			This way is not recommended since it is more complicated.<br>
			It is also described in [https://docs.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps Windows User-Mode Dumps].

	# Press Windows-key + R, type in "cmd", and press Ctrl+Shift+Enter to run it with admin rights.		# Press Windows-key + R, type in "cmd", and press Ctrl+Shift+Enter to run it with admin rights.
Line 71:		Line 79:
	Alternatively, you can add/remove registry keys directly in Registry Editor if you like.		Alternatively, you can add/remove registry keys directly in Registry Editor if you like.
	In this case, restart Windows instead of starting WerSvc service.<br>		In this case, restart Windows instead of starting WerSvc service.<br>

	~~== Compress and upload the dump ==~~

	~~Depending on what you had opened in DarkRadiant or what FM you loaded in the game itself, the .dmp file might end up very large,<br>~~
	~~so it's best to compress it by right-clicking it and selecting "Send to..." > "Compressed (zip) folder". <br>(Or use 7-zip to compress the file)<br>~~
	~~Upload that folder to some place in the web, and please go to the forums to tell the devs about your crash dump.~~
	~~<br><br>~~
	~~'''Thanks for your time''',<br>we know that recording and uploading crash dumps might be tedious, <br> but without we really can't do much about the crash, so your help is appreciated!~~

	~~== Debugging / Analysis ==~~
	~~Coders might want to check out the article on [[Analyze_a_Memory_Dump\|analyzing a memory dump.]]~~

Stgatilov: Enable Memory Dumps: simplification (no need to scare ppl away with unnecessary trash)

2022-01-22T13:54:19Z

Enable Memory Dumps: simplification (no need to scare ppl away with unnecessary trash)

← Older revision		Revision as of 13:54, 22 January 2022
Line 23:		Line 23:
	<br><br>		<br><br>
	If you don't get that window showing up for you, please check the WER flag in registry editor:		If you don't get that window showing up for you, please check the WER flag in registry editor:
	~~# open~~ the Registry Editor ~~<br>~~		* Run the Registry Editor
	~~# Locate under the key~~ <tt>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting</tt>,		* Find path: <tt>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting</tt>
	~~# create at that location the DWORD~~ <tt>~~DontShowUI~~</tt> ~~and give it the value~~ <tt>0</tt>.		* Create <tt>DWORD</tt> key with name <tt>DontShowUI</tt> and value <tt>0</tt>
	~~# Close the windows registry window, you don't need it anymore~~
	~~<br> Or do the same thing, by following procedure:~~		See alternative method here: https://superuser.com/a/1349113
	~~# Press Windows-key + R, type in "cmd",~~ and ~~press Ctrl+Shift+Enter to run it with admin rights.~~
	~~# A black window of console will appear. Check the title bar and make sure it is running with administrator rights.~~
	~~# Execute the following commands in the console (copy/paste the following line with Ctrl+C / Ctrl+V):~~
	# <tt>~~reg add "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting" /t REG_DWORD /v "DontShowUI" /d "0x0"~~</tt>
	~~# Close the console, you don't need it anymore~~
	~~<br>~~
	See alternative method ~~is by enabling it in a windows group policy. more info~~ here: https://superuser.com/a/1349113

	== Record Memory Dumps ==		== Record Memory Dumps ==

Freyk: /* Enable and record Memory Dumps automatically (alternative approach) */

2021-12-29T21:54:30Z

Enable and record Memory Dumps automatically (alternative approach)

← Older revision		Revision as of 21:54, 29 December 2021
Line 54:		Line 54:
	== Enable and record Memory Dumps automatically (alternative approach) ==		== Enable and record Memory Dumps automatically (alternative approach) ==

	It is possible to enable automatic saving of crash dumps ~~for a~~ particular program,<br>		It is possible to enable automatic saving of crash dumps, when particular program crashes<br>
	The process is also described in [https://docs.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps Windows User-Mode Dumps].		The process is also described in [https://docs.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps Windows User-Mode Dumps].