Skip to content

Commit

Permalink
tests: port symbol-mangling-hashed to rmake.rs
Browse files Browse the repository at this point in the history
- Use `object` based test logic instead of processing `nm`
  human-readable textual output.
- Try to expand test coverage to not be limited to only linux + x86_64.

Co-authored-by: binarycat <[email protected]>
  • Loading branch information
jieyouxu and lolbinarycat committed Jan 31, 2025
1 parent 0bc1b4f commit 9734ebb
Show file tree
Hide file tree
Showing 9 changed files with 128 additions and 69 deletions.
1 change: 0 additions & 1 deletion src/tools/tidy/src/allowed_run_make_makefiles.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
run-make/split-debuginfo/Makefile
run-make/symbol-mangling-hashed/Makefile
48 changes: 0 additions & 48 deletions tests/run-make/symbol-mangling-hashed/Makefile

This file was deleted.

9 changes: 0 additions & 9 deletions tests/run-make/symbol-mangling-hashed/b_bin.rs

This file was deleted.

9 changes: 0 additions & 9 deletions tests/run-make/symbol-mangling-hashed/b_dylib.rs

This file was deleted.

9 changes: 9 additions & 0 deletions tests/run-make/symbol-mangling-hashed/default_bin.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extern crate default_dylib;
extern crate hashed_dylib;
extern crate hashed_rlib;

fn main() {
hashed_rlib::hrhello();
hashed_dylib::hdhello();
default_dylib::ddhello();
}
9 changes: 9 additions & 0 deletions tests/run-make/symbol-mangling-hashed/default_dylib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#![crate_type = "dylib"]

extern crate hashed_dylib;
extern crate hashed_rlib;

pub fn ddhello() {
hashed_rlib::hrhello();
hashed_dylib::hdhello();
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#![crate_type = "dylib"]
pub fn hello() {
pub fn hdhello() {
println!("hello dylib");
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#![crate_type = "rlib"]

pub fn hello() {
pub fn hrhello() {
println!("hello rlib");
}
108 changes: 108 additions & 0 deletions tests/run-make/symbol-mangling-hashed/rmake.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
// ignore-tidy-linelength
//! Basic smoke test for the unstable option `-C symbol_mangling_version=hashed` which aims to
//! replace full symbol mangling names based on hash digests to shorten symbol name lengths in
//! dylibs for space savings.
//!
//! # References
//!
//! - MCP #705: Provide option to shorten symbol names by replacing them with a digest:
//! <https://github.com/rust-lang/compiler-team/issues/705>.
//! - Implementation PR: <https://github.com/rust-lang/rust/pull/118636>.
//! - PE format: <https://learn.microsoft.com/en-us/windows/win32/debug/pe-format>.
//@ ignore-cross-compile

#![deny(warnings)]

use run_make_support::symbols::exported_dynamic_symbol_names;
use run_make_support::{bin_name, cwd, dynamic_lib_name, is_darwin, object, rfs, run, rustc};

macro_rules! adjust_symbol_prefix {
($name:literal) => {
if is_darwin() { concat!("_", $name) } else { $name }
};
}

fn main() {
rustc()
.input("hashed_dylib.rs")
.prefer_dynamic()
.arg("-Zunstable-options")
.symbol_mangling_version("hashed")
.metadata("foo")
.run();

rustc()
.input("hashed_rlib.rs")
.prefer_dynamic()
.arg("-Zunstable-options")
.symbol_mangling_version("hashed")
.metadata("bar")
.run();

rustc().input("default_dylib.rs").library_search_path(cwd()).prefer_dynamic().run();
rustc().input("default_bin.rs").library_search_path(cwd()).prefer_dynamic().run();

{
// Check hashed symbol name

let dylib_filename = dynamic_lib_name("hashed_dylib");
println!("checking dylib `{dylib_filename}`");

let dylib_blob = rfs::read(&dylib_filename);
let dylib_file = object::File::parse(&*dylib_blob)
.unwrap_or_else(|e| panic!("failed to parse `{dylib_filename}`: {e}"));

let dynamic_symbols = exported_dynamic_symbol_names(&dylib_file);

if dynamic_symbols.iter().filter(|sym| sym.contains("hdhello")).count() != 0 {
eprintln!("exported dynamic symbols: {:#?}", dynamic_symbols);
panic!("expected no occurrence of `hdhello`");
}

let expected_prefix = adjust_symbol_prefix!("_RNxC12hashed_dylib");
if dynamic_symbols.iter().filter(|sym| sym.starts_with(expected_prefix)).count() != 2 {
eprintln!("exported dynamic symbols: {:#?}", dynamic_symbols);
panic!("expected two dynamic symbols starting with `{expected_prefix}`");
}
}

{
let dylib_filename = dynamic_lib_name("default_dylib");
println!("checking so `{dylib_filename}`");

let dylib_blob = rfs::read(&dylib_filename);
let dylib_file = object::File::parse(&*dylib_blob)
.unwrap_or_else(|e| panic!("failed to parse `{dylib_filename}`: {e}"));

let dynamic_symbols = exported_dynamic_symbol_names(&dylib_file);

if dynamic_symbols
.iter()
.filter(|sym| sym.contains("default_dylib") && sym.contains("ddhello"))
.count()
!= 1
{
eprintln!("exported dynamic symbols: {:#?}", dynamic_symbols);
panic!("expected one occurrence of mangled `ddhello`");
}

let expected_rlib_prefix = adjust_symbol_prefix!("_RNxC11hashed_rlib");
if dynamic_symbols.iter().filter(|sym| sym.starts_with(expected_rlib_prefix)).count() != 2 {
eprintln!("exported dynamic symbols: {:#?}", dynamic_symbols);
panic!("expected two exported symbols starting with `{expected_rlib_prefix}`");
}

let expected_dylib_prefix = adjust_symbol_prefix!("_RNxC12hashed_dylib");
if dynamic_symbols.iter().any(|sym| sym.starts_with("_RNxC12hashed_dylib")) {
eprintln!("exported dynamic symbols: {:#?}", dynamic_symbols);
panic!("did not expect any symbols starting with `{expected_dylib_prefix}`");
}
}

// Check that the final binary can be run.
{
let bin_filename = bin_name("default_bin");
run(&bin_filename);
}
}

0 comments on commit 9734ebb

Please sign in to comment.