Skip to content

Commit

Permalink
wasm: Explicitly export all symbols with LLD
Browse files Browse the repository at this point in the history
This commit fixes an oddity on the wasm target where LTO can produce
working executables but plain old optimizations doesn't. The compiler
already knows what set of symbols it would like to export, but LLD only
discovers this list transitively through symbol visibilities. LLD may
not, however, always find all the symbols that we'd like to export.

For example if you depend on an rlib with a `#[no_mangle]` symbol, then
if you don't actually use anything from the rlib then the symbol won't
appear in the final artifact! It will appear, however, with LTO. This
commit attempts to rectify this situation by ensuring that all symbols
rustc would otherwise preserve through LTO are also preserved through
the linking process with LLD by default.
  • Loading branch information
alexcrichton committed Oct 2, 2018
1 parent de3d640 commit c7f4f3a
Show file tree
Hide file tree
Showing 6 changed files with 89 additions and 4 deletions.
11 changes: 8 additions & 3 deletions src/libpanic_abort/lib.rs
Expand Up @@ -96,9 +96,14 @@ pub unsafe extern fn __rust_start_panic(_payload: usize) -> u32 {
// runtime at all.
pub mod personalities {
#[no_mangle]
#[cfg(not(all(target_os = "windows",
target_env = "gnu",
target_arch = "x86_64")))]
#[cfg(not(any(
target_arch = "wasm32",
all(
target_os = "windows",
target_env = "gnu",
target_arch = "x86_64",
),
)))]
pub extern fn rust_eh_personality() {}

// On x86_64-pc-windows-gnu we use our own personality function that needs
Expand Down
7 changes: 6 additions & 1 deletion src/librustc_codegen_llvm/back/linker.rs
Expand Up @@ -89,6 +89,7 @@ impl LinkerInfo {
Box::new(WasmLd {
cmd,
sess,
info: self
}) as Box<dyn Linker>
}
}
Expand Down Expand Up @@ -926,6 +927,7 @@ fn exported_symbols(tcx: TyCtxt, crate_type: CrateType) -> Vec<String> {
pub struct WasmLd<'a> {
cmd: Command,
sess: &'a Session,
info: &'a LinkerInfo,
}

impl<'a> Linker for WasmLd<'a> {
Expand Down Expand Up @@ -1021,7 +1023,10 @@ impl<'a> Linker for WasmLd<'a> {
fn build_dylib(&mut self, _out_filename: &Path) {
}

fn export_symbols(&mut self, _tmpdir: &Path, _crate_type: CrateType) {
fn export_symbols(&mut self, _tmpdir: &Path, crate_type: CrateType) {
for sym in self.info.exports[&crate_type].iter() {
self.cmd.arg("--export").arg(&sym);
}
}

fn subsystem(&mut self, _subsystem: &str) {
Expand Down
16 changes: 16 additions & 0 deletions src/test/run-make/wasm-export-all-symbols/Makefile
@@ -0,0 +1,16 @@
-include ../../run-make-fulldeps/tools.mk

ifeq ($(TARGET),wasm32-unknown-unknown)
all:
$(RUSTC) bar.rs --target wasm32-unknown-unknown
$(RUSTC) foo.rs --target wasm32-unknown-unknown
$(NODE) verify.js $(TMPDIR)/foo.wasm
$(RUSTC) bar.rs --target wasm32-unknown-unknown -O
$(RUSTC) foo.rs --target wasm32-unknown-unknown -O
$(NODE) verify.js $(TMPDIR)/foo.wasm
$(RUSTC) foo.rs --target wasm32-unknown-unknown -C lto
$(NODE) verify.js $(TMPDIR)/foo.wasm
else
all:
endif

14 changes: 14 additions & 0 deletions src/test/run-make/wasm-export-all-symbols/bar.rs
@@ -0,0 +1,14 @@
// Copyright 2018 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#![crate_type = "rlib"]

#[no_mangle]
pub extern fn foo() {}
13 changes: 13 additions & 0 deletions src/test/run-make/wasm-export-all-symbols/foo.rs
@@ -0,0 +1,13 @@
// Copyright 2018 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#![crate_type = "cdylib"]

extern crate bar;
32 changes: 32 additions & 0 deletions src/test/run-make/wasm-export-all-symbols/verify.js
@@ -0,0 +1,32 @@
// Copyright 2018 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

const fs = require('fs');
const process = require('process');
const assert = require('assert');
const buffer = fs.readFileSync(process.argv[2]);

let m = new WebAssembly.Module(buffer);
let list = WebAssembly.Module.exports(m);
console.log('exports', list);

const my_exports = {};
let nexports = 0;
for (const entry of list) {
if (entry.kind !== 'function')
continue;
my_exports[entry.name] = true;
nexports += 1;
}

if (nexports != 1)
throw new Error("should only have one function export");
if (my_exports.foo === undefined)
throw new Error("`foo` wasn't defined");

0 comments on commit c7f4f3a

Please sign in to comment.