Skip to content
forked from tuyoogame/huatuo

零成本、高性能的unity c#的热更新方案。 Zero-cost, high-performance unity c# hot update solution

Notifications You must be signed in to change notification settings

RushBitch/huatuo

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

huatuo

license


icon


huatuo是一个特性完整、零成本、高性能、低内存近乎完美的c#热更新方案。

huatuo提供一个非常完整的跨平台CLR运行时,不仅能在Android平台,也能在IOS、Consoles等限制了JIT的平台上高效地以AOT+interpreter混合模式执行。

特性

  • 特性完整。 近乎完整实现了ECMA-335规范,除了 下文中"限制和注意事项" 之外的特性都支持。
  • 零学习和使用成本。 huatuo是完整的CLR运行时,热更新代码与AOT代码无缝工作。不需要额外写任何特殊代码、没有代码生成,也没有什么特殊限制。脚本类与AOT类在同一个运行时内,即使反射、多线程(volatile、ThreadStatic、Task、async)之类的代码都能够正常工作。
  • 执行高效。实现了一个极其高效的寄存器解释器,所有指标都大幅优于其他热更新方案。性能测试报告
  • 内存高效。 热更新脚本中定义的类跟普通c#类占用一样的内存空间,远优于其他热更新方案。内存占用报告
  • 原生支持修复AOT部分代码。不额外增加任何开发和运行开销。

工作原理

huatuo从mono的Hybrid mode execution技术中得到启发,扩充了unity的il2cpp runtime,将它由纯AOT运行时改造为"AOT + Interpreter"混合运行方式,从底层彻底支持了热更新dll。

icon

更具体地说,huatuo做了以下几点工作:

  • 实现了一个高效的元数据(dll)解析库
  • 改造了il2cpp的元数据管理模块,实现了元数据的动态注册
  • 实现了一个IL指令集到自定义的寄存器指令集的compiler
  • 实现了一个高效的寄存器解释器
  • 额外提供大量的instinct函数,提升解释器性能
  • 提供hotfix AOT的支持 (进行中)

文档

完成状况

  • 几乎实现了所有规范要求的特性。除了AOT泛型这种无法通用解决的除外
  • 完成了绝大多数指令的单元测试。只有calli、initblk等少数难以或者无法构造的指令未添加对应的单元测试。
  • 对照c#规范完成各项语法测试。
  • 可以高效地加载 luban配置
  • 可以正常地纯解释器地运行2048这样的不太复杂的游戏

我们团队正全力进行huatuo的测试和修复工作,预计在2022.4(没错,下个月)能顺利运行一个大型的游戏项目

限制和注意事项

不在限制事项中的特性都是huatuo支持。请不要再问huatuo是否支持某个功能。

  • 目前仅支持 2020.3.7和3.9版本,相应的中国特供版也可以。 五月份后会支持 2018-2022 全系列版本。
  • 无法创建出普通AOT泛型(delegate、Nullable、数组(包括多维)不受限制,热更新泛型也完全不受限)的热更新非枚举值类型的实例化类型的实例。 例如不支持List<HotUpdateValueType>但支持List<int>、List<HotUpdateClass>和List<HotUpdateEnum>。 具体原因见AOT泛型限制及原理介绍。这个后续版本会基本解决。
  • 暂时不支持返回自定义值类型的默认async task,原生值类型如int及枚举及class类型不受限制。原因是编译器会为async默认生成 AsyncTaskMethodBuilder<T>的泛型类实例化,如果像ETask那样使用自定义Task及AsyncTaskMethodBuilder,则不受限制。原生async这个限制后续版本会解决。
  • 注意使用link.xml或者代码引用的方式避免unity裁减代码。避免开发期能调用,发布后却找不到函数的错误。我们后续会提供默认模板。
  • 不支持delegate的BeginInvoke, EndInvoke。纯粹是觉得没必要实现。
  • 由于Unity资源管理机制的限制(脚本uuid在打包时已确定,找不到热更新脚本对应的GUID),热更新的MonoBehaviour需要编译成独立dll的形式,挂载到资源上,才能正确反序列化
  • 暂不支持增量式gc。由于时间紧凑,来不及仔细处理增量式gc的memory barrier细节。这个问题很快会解决。
  • 暂时不支持c#源码调试,但能打印错误堆栈(只能精确到函数),也可以在Build出的Debug工程中跟踪调试。

RoadMap

huatuo虽然与il2cpp相关,但绝大多数核心代码独立于il2cpp,很容易移植(预计一个月)到其他不支持AOT+Interpreter的CLR平台。无论unity如何版本变迁,哪怕废弃了il2cpp改用.net 6+,huatuo会持续跟进,稳定地提供跨平台的CLR热更新服务,直至某天.net官方直接支持AOT+Interpreter,则huatuo完成其历史使命。

  • 持续修复bug,让一个中大型游戏正常运行 (2022.4)
  • 指令优化,编译后指令数减少到原来1/4-1/2,基础指令和大多数对象模型指令有100%-300%的性能提升。 (2022.5 出预览版本)
  • 支持unity 2018以后的全系列版本 (2022.5)
  • 支持 hotfix AOT部分的bug (2022.6)
  • 除去大多数普通AOT泛型类限制 (2022.6)
  • 支持增量式gc。 (2022.6)
  • 支持 extern函数 (2022.7)
  • 其他内存和效率优化,以及代码重构
  • ===支持godot引擎===(2022.12)

license

Huatuo is licensed under the MIT license

About

零成本、高性能的unity c#的热更新方案。 Zero-cost, high-performance unity c# hot update solution

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 90.3%
  • C 9.7%