Save a Memory Dump for debugging Crashes: Difference between revisions

From The DarkMod Wiki
Jump to navigationJump to search
Freyk (talk | contribs)
Bikerdude (talk | contribs)
 
(59 intermediate revisions by 2 users not shown)
Line 1: Line 1:
DarkRadiant or TheDarkMod crashed? If you don't want that to happen again, you need to help the team to debug this malfunction --- you can do this by dumping process memory to a file, which can then be used by developers to debug and inspect the application's state at the point in time it crashed.
DarkRadiant or TheDarkMod crashed? If you don't want that to happen again, you need to help the team to debug this malfunction <br>
You can do this by dumping process memory to a file, which can then be used by developers to debug and inspect the application's state at the point in time it crashed.


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]. 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.
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.


In principle, recording memory dumps is not limited to crashed applications. It is possible to record memory dump of alive process, although in most cases such dump would be useless.
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>


Note: At the moment this only applies to the Windows OS, we don't know if there's something similar available for Linux environments.
<b>Note:</b>
* 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.


== Record the Dump ==


== Enable Memory Dumps ==
When application crashes, it usually shows a dialog like this:
When application crashes, it usually shows a dialog like this:


[[File:Dr has stopped working.png]]
[[File:Dr has stopped working.png]]
<br><br>
If you don't get that window showing up for you, please check the WER flag in registry editor:
* Run the Registry Editor
* Find path: <tt>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting</tt>
* Create <tt>DWORD</tt> (32bit) key with name <tt>DontShowUI</tt> and value <tt>0</tt>


Note: If you don't get that window showing up for you (e.g. Windows 10), you'll probably need to re-enable that fix to make it show up again: https://superuser.com/a/1349113
See alternative method here: https://superuser.com/a/1349113


When it appears, keep that window open, '''don't close that dialog''', instead open your Task Manager. To open the Task Manager, press Ctrl + Shift + Escape. Another way is to hit Windows + R and type "taskmgr" and click OK.
== Record Memory Dumps ==
In the Task Manager, switch to the Processes tab and locate the program which crashed (DarkRadiant.exe, TheDarkModx64.exe or tdm_update.exe). It should be in that list since you still have the "XXX has stopped working" dialog open in the background.


# When the dialog appears, keep that window open, '''don't close that dialog''', instead open your Task Manager.<br> To open the Task Manager, press Ctrl + Shift + Escape.<br> Another way is to hit Windows + R and type "taskmgr" and click OK.
# In the Task Manager, switch to the Processes tab and locate the program which crashed (DarkRadiant.exe, TheDarkModx64.exe or tdm_installer.exe). <br> It should be in that list since you still have the "XXX has stopped working" dialog open in the background.
# Now right-click the line with the name of the crashed program and select "Create dump file":
# It will work a bit and then show you something like this: "The file has been sucessfully created. The file is located at: location"
# Open Windows Explorer and head to the location indicated in the dialog. <br><b>Note</b> that you can mark and copy the location from that dialog using your mouse, so you don't have to type it in entirely.
<br>
[[File:Dr process in task manager.png]]
[[File:Dr process in task manager.png]]
<br><br>
[[File:Dr process create dump.png]]
<br><br>
[[File:Dr dump created.png]]
<br>
<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!


Now right-click the DarkRadiant.exe line and select "Create dump file":
== Debugging / Analysis ==
Coders might want to check out the article on [[Analyze_a_Memory_Dump|analyzing a memory dump.]]


[[File:Dr process create dump.png]]


It will work a bit and then show you something like this:
== Record Memory Dumps automatically (alternative approach) ==


[[File:Dr dump created.png]]
When the "darkradiant has stopped working" popup doesnt appear, when the 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>
It is also described in [https://docs.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps Windows User-Mode Dumps].


Open Windows Explorer and head to the location indicated in the dialog. Note that you can mark and copy the location from that dialog using your mouse, so you don't have to type it in entirely.
# 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 them with Ctrl+C / Ctrl+V):
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_SZ /v "DumpFolder" /d "c:\temp\CrashDumps"</tt>
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_DWORD /v "DumpCount" /d "0x1"</tt>
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_DWORD /v "DumpType" /d "0x2"</tt>
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_DWORD /v "CustomDumpFlags" /d "0"</tt>
# <tt>net start WerSvc</tt> <br>(if there is a windows service named "Windows Error Reporting Service")
# Close the console, you don't need it anymore.
<br>
<br>
Now you can run TDM as usual (run executable TheDarkModx64.exe).<br>
If it crashes, a dump will be recorded and saved at <tt>C:\temp\CrashDumps</tt>.<br>
<br>
<br>
 
After this you need to disable automatic saving of memory dumps for TheDarkModx64.exe:
Most of the time when TDM chrashes, it just stops.<br>
# Press Windows-key + R, type in "cmd", and press Ctrl+Shift+Enter to run it with admin rights.
So then it is impossible to record a memorydump when the executable still "runs", using the taskmanager,<br> 
# A black window of console will appear. Check the title bar and make sure it is running with administrator rights.
But you can also use set a setting in Windows Registry, allowing that windows automatically creates a dump when the TDM executable crashes.<br>
# Execute the following commands in the console (copy/paste them with Ctrl+C / Ctrl+V):
This by enabling "[https://docs.microsoft.com/nl-nl/windows/win32/wer/collecting-user-mode-dumps windows User-Mode Dumps]". <br>
# <tt>reg delete "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe"</tt>
#window start > search for "regedit" and run the app. (or start file explorer > navigate to tdm folder, then in de menu file > open powershell, in de blue window, fill in the following command and hit the enter-key: regedit
#On the navigation secion (left side), select Computer > HKEY_LOCAL_MACHINE > SOFTWARE > Microsoft > Windows > Windows Error Reporting
#Rightclick on that folder > new > key. Call it "LocalDumps"
#in the localdumps folder, rightclick in a empty space, new >  string. name "DumpFolder", and value "%LOCALAPPDATA%\CrashDumps"
#in the localdumps folder, rightclick in a empty space, new >  dword32. name "DumpCount", and value "1" (decimal)
#in the localdumps folder, rightclick in a empty space, new >  dword32. name "DumpType", and value "2" (decimal), or value "1"
#in the localdumps folder, rightclick in a empty space, new > dword32. name "CustomDumpFlags", and value "0"
#close application and restart windows.
#Run TDM. If TDM then crashes, a dump will be recorded and placed in %LOCALAPPDATA%\CrashDumps.
#After getting a crashdump, disable the memorydump setting, by change "DumpCount" value to "0" (or to 1)
#end.
<br>
<br>
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>


== 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, so it's best to compress it now using 7-zip or by right-clicking it and selecting "Send to..." > "Compressed (zip) folder".
Upload that folder to some place in the web, and please go to the forums to tell the devs about your crash dump. '''Thanks for your time''', we know that recording and uploading crash dumps might be tedious, 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.]]


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

Latest revision as of 20:09, 18 March 2024

DarkRadiant or TheDarkMod crashed? If you don't want that to happen again, you need to help the team to debug this malfunction
You can do this by dumping process memory to a file, which can then be used by developers to debug and inspect the application's state at the point in time it crashed.

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 bugtracker.
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.

In principle, recording memory dumps is not limited to crashed applications.
It is possible to record memory dump of alive process, although in most cases such dump would be useless.

Note:

  • At the moment this only applies to the Windows OS.
  • There is similar mechanism (core dumps) on Linux environments, but it is not covered by this article yet.


Enable Memory Dumps

When application crashes, it usually shows a dialog like this:



If you don't get that window showing up for you, please check the WER flag in registry editor:

  • Run the Registry Editor
  • Find path: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting
  • Create DWORD (32bit) key with name DontShowUI and value 0

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

Record Memory Dumps

  1. When the dialog appears, keep that window open, don't close that dialog, instead open your Task Manager.
    To open the Task Manager, press Ctrl + Shift + Escape.
    Another way is to hit Windows + R and type "taskmgr" and click OK.
  2. In the Task Manager, switch to the Processes tab and locate the program which crashed (DarkRadiant.exe, TheDarkModx64.exe or tdm_installer.exe).
    It should be in that list since you still have the "XXX has stopped working" dialog open in the background.
  3. Now right-click the line with the name of the crashed program and select "Create dump file":
  4. It will work a bit and then show you something like this: "The file has been sucessfully created. The file is located at: location"
  5. Open Windows Explorer and head to the location indicated in the dialog.
    Note that you can mark and copy the location from that dialog using your mouse, so you don't have to type it in entirely.








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,
so it's best to compress it by right-clicking it and selecting "Send to..." > "Compressed (zip) folder".
(Or use 7-zip to compress the file)
Upload that folder to some place in the web, and please go to the forums to tell the devs about your crash dump.

Thanks for your time,
we know that recording and uploading crash dumps might be tedious,
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 analyzing a memory dump.


Record Memory Dumps automatically (alternative approach)

When the "darkradiant has stopped working" popup doesnt appear, when the program crashes,
then is possible to enable automatic saving of crash dumps,
This way is not recommended since it is more complicated to setup.
It is also described in Windows User-Mode Dumps.

  1. Press Windows-key + R, type in "cmd", and press Ctrl+Shift+Enter to run it with admin rights.
  2. A black window of console will appear. Check the title bar and make sure it is running with administrator rights.
  3. Execute the following commands in the console (copy/paste them with Ctrl+C / Ctrl+V):
  4. reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_SZ /v "DumpFolder" /d "c:\temp\CrashDumps"
  5. reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_DWORD /v "DumpCount" /d "0x1"
  6. reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_DWORD /v "DumpType" /d "0x2"
  7. reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_DWORD /v "CustomDumpFlags" /d "0"
  8. net start WerSvc
    (if there is a windows service named "Windows Error Reporting Service")
  9. Close the console, you don't need it anymore.


Now you can run TDM as usual (run executable TheDarkModx64.exe).
If it crashes, a dump will be recorded and saved at C:\temp\CrashDumps.

After this you need to disable automatic saving of memory dumps for TheDarkModx64.exe:

  1. Press Windows-key + R, type in "cmd", and press Ctrl+Shift+Enter to run it with admin rights.
  2. A black window of console will appear. Check the title bar and make sure it is running with administrator rights.
  3. Execute the following commands in the console (copy/paste them with Ctrl+C / Ctrl+V):
  4. reg delete "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe"


Alternatively, you can add/remove registry keys directly in Registry Editor if you like. In this case, restart Windows instead of starting WerSvc service.