min-sized-rust

min-sized-rust

Rust二进制文件大小优化技巧和方法

该项目详细介绍了多种Rust二进制文件大小优化方法,从编译选项调整到高级技术如移除标准库。内容全面且实用,适合希望减小Rust程序体积的开发者参考。此外还提供了相关工具和容器部署的建议,是一个关于Rust性能优化的综合性资源。

Rust二进制大小优化编译选项性能调优开发工具Github开源项目

最小化 Rust 二进制文件大小

GitHub Actions

本仓库演示了如何最小化 Rust 二进制文件的大小。

默认情况下,Rust 优化执行速度、编译速度和调试便利性,而不是二进制文件大小,因为这对绝大多数应用来说是理想的。但在开发者想要优化二进制文件大小的情况下,Rust 提供了实现这一目标的机制。

以发布模式构建

最低 Rust 版本: 1.0

默认情况下,cargo build 以调试模式构建 Rust 二进制文件。调试模式禁用了许多优化,这有助于调试器(以及运行它们的 IDE)提供更好的调试体验。调试版二进制文件可能比发布版大 30% 或更多。

要最小化二进制文件大小,请以发布模式构建:

$ cargo build --release

从二进制文件中剥离符号

操作系统: *nix 最低 Rust 版本: 1.59

在 Linux 和 macOS 上,默认情况下符号信息会包含在编译后的 .elf 文件中。这些信息对于正确执行二进制文件并不需要。

可以配置 Cargo 来自动剥离二进制文件的符号。修改 Cargo.toml 如下:

[profile.release] strip = true # 自动剥离二进制文件中的符号。

在 Rust 1.59 之前,直接在 .elf 文件上运行 strip

$ strip target/release/min-sized-rust

优化大小

最低 Rust 版本: 1.28

Cargo 默认将发布构建的优化级别设置为 3,这会优化二进制文件的速度。要指示 Cargo 优化最小二进制文件大小,在 Cargo.toml 中使用 z 优化级别:

[profile.release] opt-level = "z" # 优化大小。

[!注意] 在某些情况下,"s" 级别可能会比 "z" 产生更小的二进制文件,正如 opt-level 文档中所解释的:

建议尝试不同的级别,为您的项目找到合适的平衡。可能会出现一些意外结果,例如... "s""z" 级别不一定更小。

启用链接时优化(LTO)

最低 Rust 版本: 1.0

默认情况下,Cargo 指示编译单元独立编译和优化。LTO 指示链接器在链接阶段进行优化。这可以移除死代码,通常会减小二进制文件大小。

Cargo.toml 中启用 LTO:

[profile.release] lto = true

移除 Jemalloc

最低 Rust 版本: 1.28 最高 Rust 版本: 1.31

[!重要] 从 Rust 1.32 开始,jemalloc 默认被移除。如果使用 Rust 1.32 或更新版本,无需采取任何行动来减小这个特性相关的二进制文件大小

在 Rust 1.32 之前,为了提高某些平台的性能,Rust 捆绑了 jemalloc,这是一个通常优于默认系统分配器的分配器。然而,捆绑 jemalloc 会给最终的二进制文件增加约 200KB。

要在 Rust 1.28 - Rust 1.31 中移除 jemalloc,在 main.rs 顶部添加以下代码:

use std::alloc::System; #[global_allocator] static A: System = System;

减少并行代码生成单元以增加优化

默认情况下,Cargo 为发布构建指定 16 个并行代码生成单元。这改善了编译时间,但阻止了一些优化。

Cargo.toml 中将此设置为 1,以允许最大程度的大小减小优化:

[profile.release] codegen-units = 1

恐慌时中止

最低 Rust 版本: 1.10

[!重要] 到目前为止,讨论的减小二进制文件大小的特性并不会影响程序的行为(只影响其执行速度)。这个特性确实会影响行为。

默认情况下,当 Rust 代码遇到必须调用 panic!() 的情况时,它会展开栈并产生有用的回溯。然而,展开代码确实需要额外的二进制大小。可以指示 rustc 立即中止而不是展开,这样就不需要这些额外的展开代码。

Cargo.toml 中启用此功能:

[profile.release] panic = "abort"

移除位置详情

最低 Rust 版本: 每日构建版

默认情况下,Rust 包含 panic!()[track_caller] 的文件、行和列信息,以提供更有用的回溯信息。这些信息在二进制文件中占用空间,从而增加了编译后二进制文件的大小。 要移除此文件、行和列信息,请使用不稳定的 rustc -Zlocation-detail 标志:

$ RUSTFLAGS="-Zlocation-detail=none" cargo +nightly build --release

使用 build-std 优化 libstd

最低 Rust 版本:Nightly

[!注意] 另请参阅 Xargo,它是 build-std 的前身。 Xargo 目前处于维护状态

[!注意] 示例项目位于 build_std 文件夹中。

Rust 在其工具链中附带了预构建的标准库(libstd)副本。这意味着开发者无需在每次构建应用程序时都重新构建 libstdlibstd 会被静态链接到二进制文件中。

虽然这非常方便,但对于试图积极优化大小的开发者来说,存在几个缺点。

  1. 预构建的 libstd 是为速度而非大小进行优化的。

  2. 无法移除特定应用程序中未使用的 libstd 部分(例如 LTO 和 panic 行为)。

这就是 build-std 的用武之地。build-std 功能能够从源代码编译 libstd,与您的应用程序一起构建。它通过 rustup 方便提供的 rust-src 组件来实现这一点。

安装适当的工具链和 rust-src 组件:

$ rustup toolchain install nightly $ rustup component add rust-src --toolchain nightly

使用 build-std 构建:

# 找到您主机的目标三元组 $ rustc -vV ... host: x86_64-apple-darwin # 使用该目标三元组进行 build-std 构建 # 在选项中添加 =std,panic_abort 以使 Cargo.toml 中的 panic = "abort" 选项生效 # 参见:https://github.com/rust-lang/wg-cargo-std-aware/issues/56 $ RUSTFLAGS="-Zlocation-detail=none" cargo +nightly build -Z build-std=std,panic_abort \ -Z build-std-features="optimize_for_size" \ --target x86_64-apple-darwin --release

optimize_for_size 标志向 libstd 提供了一个提示,表明它应该尝试使用针对二进制大小优化的算法。有关它的更多信息可以在跟踪问题中找到。

在 macOS 上,最终剥离后的二进制文件大小减少到 51KB。

使用 panic_immediate_abort 移除 panic 字符串格式化

最低 Rust 版本:Nightly

即使在 Cargo.toml 中指定了 panic = "abort",默认情况下 rustc 仍会在最终二进制文件中包含 panic 字符串和格式化代码。 一个不稳定的 panic_immediate_abort 功能已合并到 nightly rustc 编译器中以解决这个问题。

要使用此功能,重复上述使用 build-std 的说明,但还要传递以下 -Z build-std-features=panic_immediate_abort 选项。

$ cargo +nightly build -Z build-std=std,panic_abort -Z build-std-features=panic_immediate_abort \ --target x86_64-apple-darwin --release

在 macOS 上,最终剥离后的二进制文件大小减少到 30KB。

通过 #![no_main] 和谨慎使用 libstd 移除 core::fmt

最低 Rust 版本:Nightly

[!注意] 示例项目位于 no_main 文件夹中。

到目前为止,我们没有限制从 libstd 使用的工具。在本节中,我们将限制 libstd 的使用,以进一步减小二进制文件大小。

如果您想要一个小于 20 千字节的可执行文件,必须移除 Rust 的字符串格式化代码 core::fmtpanic_immediate_abort 只移除了这些代码的一些用法。还有许多其他代码在某些情况下使用格式化。这包括 libstd 中的 Rust "预主函数" 代码。

通过使用 C 入口点(添加 #![no_main] 属性)、手动管理标准输入输出,并仔细分析您或您的依赖项包含的代码块,有时可以使用 libstd 同时避免臃肿的 core::fmt

预期代码会变得不稳定和不可移植,会比平常使用更多的 unsafe{}。感觉像是 no_std,但带有 libstd

从一个空的可执行文件开始,确保 xargo bloat --release --target=... 不包含 core::fmt 或有关填充的内容。添加(取消注释)一小部分。看看 xargo bloat 现在报告的内容是否大幅增加。检查您刚刚添加的源代码。可能使用了某个外部 crate 或新的 libstd 函数。递归地进行审查过程(需要使用 [replace] Cargo 依赖项,可能需要深入 libstd),找出为什么它比应有的重量更大。选择替代方法或修补依赖项以避免不必要的功能。取消注释更多代码,使用 xargo bloat 调试膨胀的大小,依此类推。

在 macOS 上,最终剥离后的二进制文件减小到 8KB。

通过 #![no_std] 移除 libstd

最低 Rust 版本:1.30

[!注意] 示例项目位于 no_std 文件夹中。

到目前为止,我们的应用程序一直在使用 Rust 标准库 libstdlibstd 提供了许多方便、经过良好测试的跨平台 API 和数据类型。但如果用户想要将二进制文件大小减小到等同于 C 程序的大小,可以选择只依赖 libc

重要的是要理解这种方法有许多缺点。首先,您可能需要编写大量 unsafe 代码,并失去对大多数依赖 libstd 的 Rust crate 的访问权限。尽管如此,这仍是减小二进制文件大小的一个(尽管是极端的)选择。 以这种方式构建的经过 strip 处理的二进制文件大约为 8KB。

#![no_std] #![no_main] extern crate libc; #[no_mangle] pub extern "C" fn main(_argc: isize, _argv: *const *const u8) -> isize { // 由于我们传递的是 C 字符串,最后的空字符是必需的。 const HELLO: &'static str = "Hello, world!\n\0"; unsafe { libc::printf(HELLO.as_ptr() as *const _); } 0 } #[panic_handler] fn my_panic(_info: &core::panic::PanicInfo) -> ! { loop {} }

压缩二进制文件

[!注意] 到目前为止,所有减小大小的技术都是 Rust 特有的。本节描述了一种与语言无关的二进制打包工具,它是进一步减小二进制大小的一个选择。

UPX 是一个强大的工具,用于创建自包含的、压缩的二进制文件,无需额外的运行时要求。它声称通常可以将二进制大小减少 50-70%,但实际结果取决于你的可执行文件。

$ upx --best --lzma target/release/min-sized-rust

[!警告] 有时 UPX 打包的二进制文件会触发基于启发式的杀毒软件,因为恶意软件经常使用 UPX。

工具

  • cargo-bloat - 查找可执行文件中占用最多空间的内容。
  • cargo-unused-features - 查找并删除项目中已启用但可能未使用的特性标志。
  • momo - proc_macro crate,帮助控制泛型方法的代码占用。
  • Twiggy - Wasm 的代码大小分析器。

容器

有时将 Rust 部署到容器(例如 Docker)中是有优势的。有几个很好的现有资源可以帮助创建运行 Rust 二进制文件的最小尺寸容器镜像。

参考文献

组织

  • wg-binary-size: 致力于改进 Rust 程序和库大小的工作组。

编辑推荐精选

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

下拉加载更多