Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Store metadata in import libraries for MSVC #39669

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 23 additions & 15 deletions src/librustc_metadata/locator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -862,33 +862,41 @@ fn get_metadata_section_imp(target: &Target,
if !filename.exists() {
return Err(format!("no such file: '{}'", filename.display()));
}
if flavor == CrateFlavor::Rlib {
if flavor == CrateFlavor::Rmeta {
let mut file = File::open(filename).map_err(|_|
format!("could not open file: '{}'", filename.display()))?;
let mut buf = vec![];
file.read_to_end(&mut buf).map_err(|_|
format!("failed to read rlib metadata: '{}'", filename.display()))?;
let blob = MetadataBlob::Raw(buf);
verify_decompressed_encoding_version(&blob, filename)?;
return Ok(blob);
} else if flavor == CrateFlavor::Rlib || target.options.is_like_msvc {
// With MSVC, DLLs do not contain metadata. Instead, the import library
// for the DLL is itself an Rlib.
let rlib_filename = if flavor == CrateFlavor::Rlib {
filename.to_owned()
} else {
filename.with_extension("dll.rlib")
};

// Use ArchiveRO for speed here, it's backed by LLVM and uses mmap
// internally to read the file. We also avoid even using a memcpy by
// just keeping the archive along while the metadata is in use.
let archive = match ArchiveRO::open(filename) {
let archive = match ArchiveRO::open(&rlib_filename) {
Some(ar) => ar,
None => {
debug!("llvm didn't like `{}`", filename.display());
return Err(format!("failed to read rlib metadata: '{}'", filename.display()));
debug!("llvm didn't like `{}`", rlib_filename.display());
return Err(format!("failed to read rlib metadata: '{}'", rlib_filename.display()));
}
};
return match ArchiveMetadata::new(archive).map(|ar| MetadataBlob::Archive(ar)) {
None => Err(format!("failed to read rlib metadata: '{}'", filename.display())),
None => Err(format!("failed to read rlib metadata: '{}'", rlib_filename.display())),
Some(blob) => {
verify_decompressed_encoding_version(&blob, filename)?;
verify_decompressed_encoding_version(&blob, &rlib_filename)?;
Ok(blob)
}
};
} else if flavor == CrateFlavor::Rmeta {
let mut file = File::open(filename).map_err(|_|
format!("could not open file: '{}'", filename.display()))?;
let mut buf = vec![];
file.read_to_end(&mut buf).map_err(|_|
format!("failed to read rlib metadata: '{}'", filename.display()))?;
let blob = MetadataBlob::Raw(buf);
verify_decompressed_encoding_version(&blob, filename)?;
return Ok(blob);
}
unsafe {
let buf = common::path2cstr(filename);
Expand Down
49 changes: 48 additions & 1 deletion src/librustc_trans/back/link.rs
Original file line number Diff line number Diff line change
Expand Up @@ -777,6 +777,29 @@ fn link_natively(sess: &Session,
}
info!("linker stderr:\n{}", escape_string(&prog.stderr[..]));
info!("linker stdout:\n{}", escape_string(&prog.stdout[..]));


// When linking a dynamic library with MSVC, we put the metadata
// in the import library, so we add that here.
if crate_type == config::CrateTypeDylib ||
crate_type == config::CrateTypeProcMacro {
if sess.target.target.options.is_like_msvc {
// Find the import library and add the metadata to it
let ref imp_lib_name = out_filename.with_extension("dll.lib");
let ref imp_rlib_name = out_filename.with_extension("dll.rlib");

// Import library may not exist if there were no exports
if fs::metadata(imp_lib_name).is_ok() {
add_metadata_to_existing_lib(sess, trans, Some(imp_lib_name),
imp_rlib_name, tmpdir);
// Remove plain lib file
remove(sess, imp_lib_name);
} else {
add_metadata_to_existing_lib(sess, trans, None, imp_rlib_name, tmpdir);
}
}
}

},
Err(e) => {
sess.struct_err(&format!("could not exec the linker `{}`: {}", pname, e))
Expand All @@ -803,6 +826,22 @@ fn link_natively(sess: &Session,
}
}

fn add_metadata_to_existing_lib(sess: &Session,
trans: &CrateTranslation,
input_lib: Option<&Path>,
output_rlib: &Path,
tmpdir: &Path) {

info!("adding metadata to {:?} to build {:?}", input_lib, output_rlib);
let mut ab = ArchiveBuilder::new(archive_config(sess, output_rlib, input_lib));
ab.update_symbols();

let metadata = tmpdir.join(sess.cstore.metadata_filename());
emit_metadata(sess, trans, &metadata);
ab.add_file(&metadata);
ab.build();
}

fn link_args(cmd: &mut Linker,
sess: &Session,
crate_type: config::CrateType,
Expand Down Expand Up @@ -844,7 +883,11 @@ fn link_args(cmd: &mut Linker,
// object file, so we link that in here.
if crate_type == config::CrateTypeDylib ||
crate_type == config::CrateTypeProcMacro {
cmd.add_object(&outputs.with_extension(METADATA_OBJ_NAME));
// We store the metadata in the import library instead of the DLL
// when targetting MSVC.
if !sess.target.target.options.is_like_msvc {
cmd.add_object(&outputs.with_extension(METADATA_OBJ_NAME));
}
}

// Try to strip as much out of the generated object by removing unused
Expand Down Expand Up @@ -1157,6 +1200,9 @@ fn add_upstream_rust_crates(cmd: &mut Linker,
lib.kind == NativeLibraryKind::NativeStatic && !relevant_lib(sess, lib)
});

// If we're not doing LTO, don't need to remove metadata, and don't
// want to skip specific object files, then we can take the fast path,
// and pass the library directly to the linker without modification.
if !sess.lto() && crate_type != config::CrateTypeDylib && !skip_native {
cmd.link_rlib(&fix_windows_verbatim_for_gcc(cratepath));
return
Expand Down Expand Up @@ -1240,6 +1286,7 @@ fn add_upstream_rust_crates(cmd: &mut Linker,
if let Some(dir) = parent {
cmd.include_path(&fix_windows_verbatim_for_gcc(dir));
}

let filestem = cratepath.file_stem().unwrap().to_str().unwrap();
cmd.link_rust_dylib(&unlib(&sess.target, filestem),
parent.unwrap_or(Path::new("")));
Expand Down
2 changes: 1 addition & 1 deletion src/librustc_trans/back/linker.rs
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ impl<'a> Linker for MsvcLinker<'a> {
// `foo.lib` file if the dll doesn't actually export any symbols, so we
// check to see if the file is there and just omit linking to it if it's
// not present.
let name = format!("{}.dll.lib", lib);
let name = format!("{}.dll.rlib", lib);
if fs::metadata(&path.join(&name)).is_ok() {
self.cmd.arg(name);
}
Expand Down
8 changes: 6 additions & 2 deletions src/librustc_trans/back/symbol_export.rs
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,12 @@ impl ExportedSymbols {
}

if scx.sess().crate_types.borrow().contains(&config::CrateTypeDylib) {
local_crate.push((scx.metadata_symbol_name(),
SymbolExportLevel::Rust));
// When targetting MSVC, metadata is stored in import library
// so don't add an exported symbol for it.
if !scx.sess().target.target.options.is_like_msvc {
local_crate.push((scx.metadata_symbol_name(),
SymbolExportLevel::Rust));
}
}

let mut exports = FxHashMap();
Expand Down