|
| 1 | +// ignore-tidy-linelength |
| 2 | +//! Basic smoke test for the unstable option `-C symbol_mangling_version=hashed` which aims to |
| 3 | +//! replace full symbol mangling names based on hash digests to shorten symbol name lengths in |
| 4 | +//! dylibs for space savings. |
| 5 | +//! |
| 6 | +//! # References |
| 7 | +//! |
| 8 | +//! - MCP #705: Provide option to shorten symbol names by replacing them with a digest: |
| 9 | +//! <https://github.com/rust-lang/compiler-team/issues/705>. |
| 10 | +//! - Implementation PR: <https://github.com/rust-lang/rust/pull/118636>. |
| 11 | +//! - PE format: <https://learn.microsoft.com/en-us/windows/win32/debug/pe-format>. |
| 12 | +
|
| 13 | +//@ ignore-cross-compile |
| 14 | + |
| 15 | +#![deny(warnings)] |
| 16 | + |
| 17 | +use run_make_support::symbols::exported_dynamic_symbol_names; |
| 18 | +use run_make_support::{bin_name, cwd, dynamic_lib_name, is_darwin, object, rfs, run, rustc}; |
| 19 | + |
| 20 | +macro_rules! adjust_symbol_prefix { |
| 21 | + ($name:literal) => { |
| 22 | + if is_darwin() { concat!("_", $name) } else { $name } |
| 23 | + }; |
| 24 | +} |
| 25 | + |
| 26 | +fn main() { |
| 27 | + rustc() |
| 28 | + .input("hashed_dylib.rs") |
| 29 | + .prefer_dynamic() |
| 30 | + .arg("-Zunstable-options") |
| 31 | + .symbol_mangling_version("hashed") |
| 32 | + .metadata("foo") |
| 33 | + .run(); |
| 34 | + |
| 35 | + rustc() |
| 36 | + .input("hashed_rlib.rs") |
| 37 | + .prefer_dynamic() |
| 38 | + .arg("-Zunstable-options") |
| 39 | + .symbol_mangling_version("hashed") |
| 40 | + .metadata("bar") |
| 41 | + .run(); |
| 42 | + |
| 43 | + rustc().input("default_dylib.rs").library_search_path(cwd()).prefer_dynamic().run(); |
| 44 | + rustc().input("default_bin.rs").library_search_path(cwd()).prefer_dynamic().run(); |
| 45 | + |
| 46 | + { |
| 47 | + // Check hashed symbol name |
| 48 | + |
| 49 | + let dylib_filename = dynamic_lib_name("hashed_dylib"); |
| 50 | + println!("checking dylib `{dylib_filename}`"); |
| 51 | + |
| 52 | + let dylib_blob = rfs::read(&dylib_filename); |
| 53 | + let dylib_file = object::File::parse(&*dylib_blob) |
| 54 | + .unwrap_or_else(|e| panic!("failed to parse `{dylib_filename}`: {e}")); |
| 55 | + |
| 56 | + let dynamic_symbols = exported_dynamic_symbol_names(&dylib_file); |
| 57 | + |
| 58 | + if dynamic_symbols.iter().filter(|sym| sym.contains("hdhello")).count() != 0 { |
| 59 | + eprintln!("exported dynamic symbols: {:#?}", dynamic_symbols); |
| 60 | + panic!("expected no occurrence of `hdhello`"); |
| 61 | + } |
| 62 | + |
| 63 | + let expected_prefix = adjust_symbol_prefix!("_RNxC12hashed_dylib"); |
| 64 | + if dynamic_symbols.iter().filter(|sym| sym.starts_with(expected_prefix)).count() != 2 { |
| 65 | + eprintln!("exported dynamic symbols: {:#?}", dynamic_symbols); |
| 66 | + panic!("expected two dynamic symbols starting with `{expected_prefix}`"); |
| 67 | + } |
| 68 | + } |
| 69 | + |
| 70 | + { |
| 71 | + let dylib_filename = dynamic_lib_name("default_dylib"); |
| 72 | + println!("checking so `{dylib_filename}`"); |
| 73 | + |
| 74 | + let dylib_blob = rfs::read(&dylib_filename); |
| 75 | + let dylib_file = object::File::parse(&*dylib_blob) |
| 76 | + .unwrap_or_else(|e| panic!("failed to parse `{dylib_filename}`: {e}")); |
| 77 | + |
| 78 | + let dynamic_symbols = exported_dynamic_symbol_names(&dylib_file); |
| 79 | + |
| 80 | + if dynamic_symbols |
| 81 | + .iter() |
| 82 | + .filter(|sym| sym.contains("default_dylib") && sym.contains("ddhello")) |
| 83 | + .count() |
| 84 | + != 1 |
| 85 | + { |
| 86 | + eprintln!("exported dynamic symbols: {:#?}", dynamic_symbols); |
| 87 | + panic!("expected one occurrence of mangled `ddhello`"); |
| 88 | + } |
| 89 | + |
| 90 | + let expected_rlib_prefix = adjust_symbol_prefix!("_RNxC11hashed_rlib"); |
| 91 | + if dynamic_symbols.iter().filter(|sym| sym.starts_with(expected_rlib_prefix)).count() != 2 { |
| 92 | + eprintln!("exported dynamic symbols: {:#?}", dynamic_symbols); |
| 93 | + panic!("expected two exported symbols starting with `{expected_rlib_prefix}`"); |
| 94 | + } |
| 95 | + |
| 96 | + let expected_dylib_prefix = adjust_symbol_prefix!("_RNxC12hashed_dylib"); |
| 97 | + if dynamic_symbols.iter().any(|sym| sym.starts_with("_RNxC12hashed_dylib")) { |
| 98 | + eprintln!("exported dynamic symbols: {:#?}", dynamic_symbols); |
| 99 | + panic!("did not expect any symbols starting with `{expected_dylib_prefix}`"); |
| 100 | + } |
| 101 | + } |
| 102 | + |
| 103 | + // Check that the final binary can be run. |
| 104 | + { |
| 105 | + let bin_filename = bin_name("default_bin"); |
| 106 | + run(&bin_filename); |
| 107 | + } |
| 108 | +} |
0 commit comments