ToB企服应用市场:ToB评测及商务社交产业平台

标题: AOT漫谈专题(第五篇): 如何挟制.NET AOT编译器 进行源码级调试 [打印本页]
作者: 反转基因福娃    时间: 2024-10-16 16:50
标题: AOT漫谈专题(第五篇): 如何挟制.NET AOT编译器 进行源码级调试
一：背景

1. 讲故事

上篇聊到了 C#步伐编译成Native代码 的宏观过程，有粉丝朋侪提了一个问题，能不能在 dotnet publish 发布的过程中对AOT编译器拦截进行源码级调试，这是一个好问题，也是深度研究的必经之路，这篇我们就来分享下吧。
二：托管和非托管调试器

1. 调试器介绍

信赖大家现在都知道AOT Compiler (ilc.exe) 是用 C# 代码写的，也就表明它是一个托管步伐，对托管步伐的调试有两种调试器：
调试 C# 代码它是当仁不让，缺点在于对非托管部分的查看缺少了手段。
调试 C/C++ 是一把利器，但用它调试托管的C#代码，固然可以用，但在变量显示各方面不是很直观。
截个图如下，总之各有利弊吧：

2. 测试代码

为了方便演示，先上一段测试代码，非常简单。
  1.     internal class Program
  2.     {
  3.         static void Main(string[] args)
  4.         {
  5.             Console.WriteLine("Hello, World!");
  6.             Console.ReadLine();
  7.         }
  8.     }
复制代码
有了代码之后，接下来一起观赏下如何通过 Visual Studio 和 Windbg 实现各自的拦截。
三：调试器拦截实战

1. WinDbg 拦截

作为 Windows平台上王者般存在的非托管调试器，用它来挟制ilc.exe非常方便，在注册表的 HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Options\ilc.exe 下设置个 Deubgger 键值即可，截图如下：

接下来使用 dotnet publish 发布步伐，稍等片刻之后会看到 windbg 立即启动拦截了 ilc.exe，然后 ctrl+o 打开我们需要下断点的 cs 文件，好比核心的 Compilation 方法，下完断点之后直接 g 执行，截图如下：

从卦中可以看到 Compilation.ctor 果然命中，而且用 dv 也能看到各个局部变量的内存所在，是不是挺故意思的。
总的来说这种方式使用起来简单粗暴，但用 windbg 这种非托管调试器调试C# 总有点 名不正言不顺，更好的方式应该照旧用 visual studio 这种专业级的家宝，不是吗？
2. Visual Studio 拦截

上一篇文章跟大家说过执行 dotnet publish 调用的ilc.exe 是来自于目次 .nuget\packages\runtime.win-x64.microsoft.dotnet.ilcompiler\8.0.8\tools 下的，截图如下：

为了能够用上托管调试器，这里我们把 ilc.sln 项目手工编译出一个 ilc.exe 来替换这里的 ilc.exe 即可，截图如下：

为了能够让 VS 附加到 ilc.exe 进程上，ilc 提供了一个 --waitfordebugger 参数，参考如下：
  1. PS D:\csharpapplication\21.20240910\src\Example\Example_21_1> ilc -h
  2. Description:
  3.   .NET Native IL Compiler
  5. Usage:
  6.   ilc <input-file-path>... [options]
  8. Arguments:
  9.   <input-file-path>  Input file(s)
  11. Options:
  12.   -?, -h, --help                  Show help and usage information
  13.   ...
  14.   --waitfordebugger               Pause to give opportunity to attach debugger
复制代码
这个参数的作用就是通过 Console.ReadLine 让步伐暂停，好让你用 VS 去 Attach ，源码中是这么写的：
  1.         public Program(ILCompilerRootCommand command)
  2.         {
  3.             _command = command;
  5.             if (Get(command.WaitForDebugger))
  6.             {
  7.                 Console.WriteLine("Waiting for debugger to attach. Press ENTER to continue");
  8.                 Console.ReadLine();
  9.             }
  10.         }
复制代码
但在我手工编译的 ilc.exe 上用 Console.ReadLine 貌似拦不住，所以这里稍微改一下，参考如下：
  1.         public Program(ILCompilerRootCommand command)
  2.         {
  3.             _command = command;
  5.             while (!Debugger.IsAttached)
  6.             {
  7.                 Console.WriteLine("Waiting for debugger to attach. Press ENTER to continue");
  8.                 //Console.ReadLine();
  9.                 Thread.Sleep(1000);
  10.             }
  11.         }
复制代码
接下来重新编译项目，将生成目次 runtime\artifacts\bin\coreclr\windows.x64.Debug\ilc\net8.0 下的所有文件复制到nugut目次 .nuget\packages\runtime.win-x64.microsoft.dotnet.ilcompiler\8.0.8\tools 下，截图如下：

一切都准备好之后，接下来使用 dotnet publish 重新发布步伐，从 cmd 输出中可以看到正在等候 attach 附加。
  1. PS D:\csharpapplication\21.20240910\src\Example\Example_21_1> dotnet publish  -r win-x64 -c Debug -o D:\testdump
  2.   正在确定要还原的项目…
  3.   所有项目均是最新的，无法还原。
  4.   Example_21_1 -> D:\csharpapplication\21.20240910\src\Example\Example_21_1\bin\Debug\net8.0\win-x64\Example_21_1.d
  5.   ll
  6.   Generating native code
  7.   Waiting for debugger to attach. Press ENTER to continue
  8.   Waiting for debugger to attach. Press ENTER to continue
  9.   Waiting for debugger to attach. Press ENTER to continue
  10.   Waiting for debugger to attach. Press ENTER to continue
  11.   Waiting for debugger to attach. Press ENTER to continue
复制代码
在VS菜单上 Debug -> Attach to Process 到我们的 ilc.exe 进程，可以看到果然就命中了，大家看看这调试体验是不是高了很多，截图如下：

体验过这种方式的朋侪我信赖又有一些新的问题，那就是重复调试的时候太麻烦了，能不能直接以 启动步伐 的方式来调试？这就是接下来我们要聊的。
3. VS 对ilc的启动调试

看过上篇的朋侪知道，每一次AOT编译之前在 native 目次下都会有一个 xxx.ilc.rsp ，这个文件是 AOT Compiler 的 input 来源，截图如下：

所以完全可以将它作为 ilc.sln 项目标启动参数，接下来我们将 @D:\csharpapplication\21.20240910\src\Example\Example_21_1\obj\Debug\net8.0\win-x64\native\Example_21_1.ilc.rsp 放到 ILCompiler 项目标 command line 中，截图如下：

设置好之后，接下来把 Example_21_1.ilc.rsp 中的 Example_21_1.dll,Example_21_1.obj,Example_21_1.def 三块都改玉成路径，参考如下：
  1. D:\csharpapplication\21.20240910\src\Example\Example_21_1\obj\Debug\net8.0\win-x64\Example_21_1.dll
  2. -o:D:\csharpapplication\21.20240910\src\Example\Example_21_1\obj\Debug\net8.0\win-x64\native\Example_21_1.obj
  3. -r:C:\Users\Administrator\.nuget\packages\microsoft.netcore.app.runtime.win-x64\8.0.8\runtimes\win-x64\lib\net8.0\WindowsBase.dll
  4. -r:C:\Users\Administrator\.nuget\packages\runtime.win-x64.microsoft.dotnet.ilcompiler\8.0.8\sdk\System.Private.CoreLib.dll
  5. ...
  6. --targetarch:x64
  7. --dehydrate
  8. -g
  9. --exportsfile:D:\csharpapplication\21.20240910\src\Example\Example_21_1\obj\Debug\net8.0\win-x64\native\Example_21_1.def
  10. ...
复制代码
直接 F5 启动 ILCompiler 项目，可以看到轻轻松松的成功调试，这种方式就很好的解决了反复调试的问题，截图如下：

三：总结

以挟制的方式对 AOT Compiler 自身进行源码级调试，这自己就是一个很故意思的话题，不断的介入Compiler编译的的各个阶段，信赖能给大家深度学习AOT提供了一些不寻常的手段。


免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。



欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/) Powered by Discuz! X3.4