ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 10:17:22 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Merge pull request #2377 from KazWolfe/assert-blame
Some checks failed
Tag Build / Tag Build (push) Successful in 4s
Details
Build Dalamud / Build on Windows (push) Has been cancelled
Details
Build Dalamud / Check API Compatibility (push) Has been cancelled
Details
Build Dalamud / Deploy dalamud-distrib staging (push) Has been cancelled
Details

Browse source 
feat: Identify the plugin causing an assertion failure
This commit is contained in:
goat 2025-11-04 21:44:38 +01:00 • committed by GitHub
commit 832edaf005
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 87 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

86
Dalamud/Interface/Internal/Asserts/AssertHandler.cs
View file

@ -1,9 +1,11 @@
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Runtime.InteropServices;
using System.Threading;
using System.Windows.Forms;
using Dalamud.Plugin.Internal;
using Dalamud.Utility;
using Serilog;
@ -55,7 +57,8 @@ internal class AssertHandler : IDisposable
/// </summary>
public unsafe void Setup()
{
CustomNativeFunctions.igCustom_SetAssertCallback(Marshal.GetFunctionPointerForDelegate(this.callback).ToPointer());
CustomNativeFunctions.igCustom_SetAssertCallback(
Marshal.GetFunctionPointerForDelegate(this.callback).ToPointer());
}
/// <summary>
@ -72,13 +75,50 @@ internal class AssertHandler : IDisposable
this.Shutdown();
}
private static string? ExtractImguiFunction(StackTrace stackTrace)
{
var frame = stackTrace.GetFrames()
.FirstOrDefault(f => f.GetMethod()?.DeclaringType?.Namespace == "Dalamud.Bindings.ImGui");
if (frame == null)
return null;
var method = frame.GetMethod();
if (method == null)
return null;
return $"{method.Name}({string.Join(", ", method.GetParameters().Select(p => p.Name))})";
}
private static StackTrace GenerateStackTrace()
{
var trace = DiagnosticUtil.GetUsefulTrace(new StackTrace(true));
var frames = trace.GetFrames().ToList();
// Remove everything that happens in the assert context.
var lastAssertIdx = frames.FindLastIndex(f => f.GetMethod()?.DeclaringType == typeof(AssertHandler));
if (lastAssertIdx >= 0)
{
frames.RemoveRange(0, lastAssertIdx + 1);
}
var firstInterfaceManagerIdx = frames.FindIndex(f => f.GetMethod()?.DeclaringType == typeof(InterfaceManager));
if (firstInterfaceManagerIdx >= 0)
{
frames.RemoveRange(firstInterfaceManagerIdx, frames.Count - firstInterfaceManagerIdx);
}
return new StackTrace(frames);
}
private unsafe void OnImGuiAssert(void* pExpr, void* pFile, int line)
{
var expr = Marshal.PtrToStringAnsi(new IntPtr(pExpr));
var file = Marshal.PtrToStringAnsi(new IntPtr(pFile));
if (expr == null || file == null)
{
Log.Warning("ImGui assertion failed: {Expr} at {File}:{Line} (failed to parse)",
Log.Warning(
"ImGui assertion failed: {Expr} at {File}:{Line} (failed to parse)",
expr,
file,
line);
@ -93,7 +133,7 @@ internal class AssertHandler : IDisposable
if (!this.ShowAsserts && !this.everShownAssertThisSession)
return;
Lazy<string> stackTrace = new(() => DiagnosticUtil.GetUsefulTrace(new StackTrace()).ToString());
Lazy<StackTrace> stackTrace = new(GenerateStackTrace);
if (!this.EnableVerboseLogging)
{
@ -103,7 +143,8 @@ internal class AssertHandler : IDisposable
if (count <= HideThreshold || count % HidePrintEvery == 0)
{
Log.Warning("ImGui assertion failed: {Expr} at {File}:{Line} (repeated {Count} times)",
Log.Warning(
"ImGui assertion failed: {Expr} at {File}:{Line} (repeated {Count} times)",
expr,
file,
line,
@ -117,11 +158,12 @@ internal class AssertHandler : IDisposable
}
else
{
Log.Warning("ImGui assertion failed: {Expr} at {File}:{Line}\n{StackTrace:l}",
Log.Warning(
"ImGui assertion failed: {Expr} at {File}:{Line}\n{StackTrace:l}",
expr,
file,
line,
stackTrace.Value);
stackTrace.Value.ToString());
}
if (!this.ShowAsserts)
@ -145,7 +187,8 @@ internal class AssertHandler : IDisposable
}
// grab the stack trace now that we've decided to show UI.
_ = stackTrace.Value;
var responsiblePlugin = Service<PluginManager>.GetNullable()?.FindCallingPlugin(stackTrace.Value);
var responsibleMethodCall = ExtractImguiFunction(stackTrace.Value);
var gitHubUrl = GetRepoUrl();
var showOnGitHubButton = new TaskDialogButton
@ -175,12 +218,37 @@ internal class AssertHandler : IDisposable
var ignoreButton = TaskDialogButton.Ignore;
TaskDialogButton? result = null;
void DialogThreadStart()
{
// TODO(goat): This is probably not gonna work if we showed the loading dialog
// this session since it already loaded visual styles...
Application.EnableVisualStyles();
string text;
if (responsiblePlugin != null)
{
text = $"The plugin \"{responsiblePlugin.Name}\" appears to have caused an ImGui assertion failure. " +
$"Please report this problem to the plugin's developer.\n\n";
}
else
{
text = "Some code in a plugin or Dalamud itself has caused an ImGui assertion failure. " +
"Please report this problem in the Dalamud discord.\n\n";
}
text += $"You may attempt to continue running the game, but Dalamud UI elements may not work " +
$"correctly, or the game may crash after resuming.\n\n";
if (responsibleMethodCall != null)
{
text += $"Assertion failed: {expr} when performing {responsibleMethodCall}\n{file}:{line}";
}
else
{
text += $"Assertion failed: {expr}\nAt: {file}:{line}";
}
var page = new TaskDialogPage
{
Heading = "ImGui assertion failed",
@ -189,9 +257,9 @@ internal class AssertHandler : IDisposable
{
CollapsedButtonText = "Show stack trace",
ExpandedButtonText = "Hide stack trace",
Text = stackTrace.Value,
Text = stackTrace.Value.ToString(),
},
Text = $"Some code in a plugin or Dalamud itself has caused an internal assertion in ImGui to fail. The game will most likely crash now.\n\n{expr}\nAt: {file}:{line}",
Text = text,
Icon = TaskDialogIcon.Warning,
Buttons =
[