BizHawk模拟器中Lua脚本操作工具窗口引发的崩溃问题分析

问题概述

在BizHawk模拟器项目中，当通过Lua脚本直接或间接打开/关闭工具窗口时，经常会导致ToolManager._tools集合在枚举过程中被修改，从而引发"Collection was modified"异常，最终导致模拟器崩溃。这个问题影响了从2.5.0到最新开发版的多个BizHawk版本。

技术背景

BizHawk的ToolManager类负责管理模拟器中各种工具窗口的生命周期。工具窗口包括十六进制编辑器、内存查看器等辅助功能。这些工具窗口的状态会随着用户操作或脚本命令发生变化。

问题的核心在于ToolManager类内部使用了一个List<T>集合来维护当前打开的工具窗口实例。当Lua脚本在特定时机（如帧更新事件中）调用client.openhexeditor()等函数时，会触发工具窗口的创建和添加操作，而此时系统可能正在遍历这个集合。

问题复现场景

开发人员发现了多种触发此问题的场景：

1. 直接打开工具窗口：在Lua脚本中调用client.openhexeditor()等工具打开函数，特别是在帧更新事件中调用时。

2. 间接触发工具关闭：通过client.closerom()或打开无效ROM文件等操作，导致依赖ROM的工具窗口被自动关闭。

3. 核心重启时：在脚本中打开工具窗口后重启模拟器核心。

这些操作都会在ToolManager枚举工具集合的过程中修改该集合，违反了集合枚举的线程安全规则。

技术分析

问题的本质是集合的并发修改问题。在.NET中，List<T>等集合类型在枚举过程中不允许被修改，这是设计上的安全限制。当以下两个操作同时发生时就会触发异常：

1. 主线程正在执行foreach (var tool in _tools)循环（如更新工具状态）
2. Lua脚本线程（或事件回调）尝试修改_tools集合（添加/删除工具）

解决方案探讨

开发团队考虑了多种解决方案：

1. 使用不可变集合：将_tools从List<T>改为ImmutableArray<T>，利用其线程安全特性。这种方案通过写时复制机制保证枚举安全，但可能带来轻微的性能开销。

2. 防御性复制：在每次枚举前创建集合的副本。这种方法简单直接，但在高频调用场景下可能产生不必要的内存分配。

3. 同步锁机制：使用锁来保护集合访问。这种方法可能引入死锁风险，且需要谨慎设计锁粒度。

经过评估，团队最终选择了第一种方案，因为工具窗口的打开/关闭操作相对不频繁，而枚举操作则非常频繁。不可变集合在这种场景下能提供更好的整体性能表现。

影响范围与修复

该问题影响了BizHawk 2.5.0至2.9.1版本，在2.9.2开发版中得到了修复。修复后，Lua脚本可以安全地在各种事件回调中操作工具窗口，不会导致模拟器崩溃。

这个问题也提醒开发者，在设计插件/脚本系统时，需要特别注意跨线程的资源访问安全问题，特别是当外部代码可能在任何时候修改内部状态时。