Remove debug_info from panic

cyberpunk · April 14, 2024, 4:23pm

Hello,
i want to completly remove the debug informations that rust compiled in my binary for the panic functions. I want do preserve the functions that panic and only catch the panic functions, that there not show debug informations (only my own infos) and let the rest of the panic function functional.

I want only the debug_infos out of my binary and let the panic functions functional.

How i can i do that globally?

When i hook or something in my main.rs the binary size going to 20% and all functions that can panic and i have matched like options and results are still not functional.

thx

kornel · April 14, 2024, 7:20pm

I've just implemented something like it that disables Debug::fmt:

github.com/rust-lang/rust

debug-fmt-detail option

rust-lang:master ← kornelski:remove-derived-debug

opened 07:16PM - 14 Apr 24 UTC

kornelski

+74 -12

I'd like to propose a new option that makes `#[derive(Debug)]` generate no-op im…plementations that don't print anything, and makes `{:?}` in format strings a no-op. There are a couple of motivations for this: 1. A more thorough stripping of debug symbols. Binaries stripped of debug symbols still retain some of them through `Debug` implementations. It's hard to avoid that without compiler's help, because debug formatting can be used in many places, including dependencies, and their loggers, asserts, panics, etc. * In my testing it gives about 2% binary size reduction on top of all other binary-minimizing best practices (including `panic_immediate_abort`). There are targets like Web WASM or embedded where users pay attention to binary sizes. * Users distributing closed-source binaries may not want to "leak" any symbol names as a matter of principle. 2. Adds ability to test whether code depends on specifics of the `Debug` format implementation in unwise ways (e.g. trying to get data unavailable via public interface, or using it as a serialization format). Because current Rust's debug implementation doesn't change, there's a risk of it becoming a fragile de-facto API that [won't be possible to change in the future](https://www.hyrumslaw.com/). An option that "breaks" it can act as a [grease](https://www.rfc-editor.org/rfc/rfc8701.html). This implementation is a `-Z debug-fmt-detail=opt` flag that takes: * `full` — the default, current state. * `none` — makes derived `Debug` and `{:?}` no-ops. Explicit `impl Debug for T` implementations are left unharmed, but `{:?}` format won't use them, so they may get dead-code eliminated if they aren't invoked directly. * `shallow` — makes derived `Debug` print only the type's name, without recursing into fields. Fieldless enums print their variant names. `{:?}` works. The `shallow` option is a compromise between minimizing the `Debug` code, and compatibility. There are popular proc-macro crates that use `Debug::fmt` as a way to convert enum values into their Rust source code. There's a corresponding `cfg` flag: `#[cfg(debug_fmt_detail = "none")]` that can be used in user code to react to this setting to minimize custom `Debug` implementations or remove unnecessary formatting helper functions.

But in the official compiler builds, there's no good way to do that. There's -Zlocation-detail that removes file paths, but not the Debug text. There's possibility of rebuilding libstd with panic_immediate_abort that removes all panic text, but also removes ability to catch panics.

cyberpunk · April 14, 2024, 7:40pm

@kornel Yes a very good suggestion. I don't know why the rust-core-team are so against a complete debug info free binary. Only one compiler setting parameter and we the coders have a free choice. I hope in the future option like yours will be in the stable branch and we can remove more debug infos out of the binary.

I have so long only coded with the stable branch. And now i must istall the nightly branch and use -Zlocation-detail=none for a little removing of some debug infos.

Install xargo and rebuilding libstd to use panic_immediate_abort is to crazy for me.

thx

kornel · April 14, 2024, 9:13pm

xargo is not necessary any more. Regular cargo nightly can build std.

cyberpunk · April 14, 2024, 9:52pm

@kornel I test a little bit, do you know a newer tutorial to rebuild the libstd? The tutorials under https://github.com/johnthagen/min-sized-rust dont't compile.
thx

cyberpunk · April 14, 2024, 10:52pm

@kornel Oh no its functioned. "RUSTFLAGS=-Zlocation-detail=none" and rebuild of libstd with cargo +nightly build -Z build-std=std,panic_abort -Z build-std-features=panic_immediate_abort --target x86_64-pc-windows-gnu --release the most debug infos are striped and the size of binary is crunched to around 20%. Thats cool, thx for your tips.

system · July 13, 2024, 10:53pm

This topic was automatically closed 90 days after the last reply. We invite you to open a new topic if you have further questions or comments.

Topic		Replies	Views
How to ship rust binaries with reasonable backtraces? help	6	928	August 25, 2021
Keeping debug info, but smaller? help	4	626	May 3, 2021
Disable panic in small bare metal systems Embedded	5	2014	August 29, 2022
Rust binary sizes, once again	6	3705	January 12, 2023
Binary size, debug info, libunwind	1	523	January 12, 2023

Remove debug_info from panic

Related topics