Photon Server Stack Overflow
Stack Overflow is a background exception that may cause silent craches. It is tricky to debug it. This document explains how to deal with stack overflow exceptions occurring due to custom code running on Photon Server.
This is the procedure we recommend to follow in order to gather dumps and a stack trace from it in case of a stack overflow.
Download and install WinDBG. Windows Debugger is part of Windows Development Kit. Please download the appropriate dev. SDK for your Windows version and choose "Debugging Tools For Windows" as a feature to be installed during installation wizard.
Setup Debug Diagnostic Tool: Dump Collection
We are going to follow a step-by-step guide:
Open Debug Diagnostic Tool ("DebugDiag 2 Collection"). By default a "Select Rule Type" wizard window should be open. Otherwise, please click "Add Rule". Select "Crash" as "Rule Type" and hit "Next".
In "Select Target Type" window, select "A specific process" and hit "Next".
In the "Select Target" window, choose "PhotonSocketServer.exe" from the list and hit "Next".
In the "Advanced Configuration" window, "Advanced Settings" section click on "Exceptions".
In the "First Chance Exception Configuration" window, click "Add Exception...".
In the "Configure Exception" window, choose "Stack Overflow" from the list of exceptions. Then on the right, from the dropdown menu choose "Full Userdump" as "Action Type" and set "Action Limit" to 0. Once done, click "OK".
A warning dialog will be shown to you about the Action Limit value 0. Continue by clicking "Yes".
Now you are able to see the configure Stack Overflow exception added in the "First Chance Exception Configuration" window. Hit "Save & Close".
Back to the "Advanced Configuration" window, just hit "Next".
In the "Select Dump Location And Rule Name" window, you can change the default rule name. Set the "Userdump Location" to a temporary folder path of your choice and click "Next".
The "Add Rule" wizard reaches its final window "Rule Completed". Choose "Activate the rule now" and hit "Finish".
The Debug Diagnostic should prompt you to automatically set the "Symbol Search Path" to
In case it doesn't, please manually set this in "Tools" -> "Options & Settings" to get a better stacktrace.
Back to the main Debug Diagnostic Tool window, you can see the configured rule.
Setup Debug Diagnostic Tool: Dump Analysis
Now let's open Debug Diagnostic Tool ("Debug Diag 2 Analysis").
Let's add the dump file using "Add Data Files".
Once we have added the dump file, we can "Start Analysis".
You should see the analysis loading which could take some time, then a report will be open in the browser.
Open The Dump Using Visual Studio
Open the dump file in Visual Studio and run "Debug Mixed Mode".
The debugging will break when the stack overflow exception occurs. You will get the exception breakpoint and a full stack trace.
Open The Dump Using WinDBG
Open the dump using WinDBG and set the following commands:
.loadby sos clr. (Note:
.loadby sos clris if you are debugging .NET 4.0 or above, otherwise the command is
.loadby sos mscorwks.)
You can notice that once the rule is added you can't attach Visual Studio debugger to "PhotonSocketServer" process. This is because the Debug Diagnostic Tool auto attaches as debugger to the process configured in the rule. If you happen to start Photon Server from Visual Studio when Debug Diagnostic Tool is running with an active rule for Photon Server, the latter will crash on startup without leaving any dump.
We recommend to remove the following registry keys to make sure the debugging tools don't get in the way of each other:
HKEYLOCALMACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps