1 //! A helper class for dealing with static archives
4 use std::ffi::{c_char, c_void, CStr, CString, OsString};
7 use std::path::{Path, PathBuf};
13 DlltoolFailImportLibrary, ErrorCallingDllTool, ErrorCreatingImportLibrary, ErrorWritingDEFFile,
15 use crate::llvm::archive_ro::{ArchiveRO, Child};
16 use crate::llvm::{self, ArchiveKind, LLVMMachineType, LLVMRustCOFFShortExport};
17 use rustc_codegen_ssa::back::archive::{
18 get_native_object_symbols, ArArchiveBuilder, ArchiveBuildFailure, ArchiveBuilder,
19 ArchiveBuilderBuilder, UnknownArchiveKind,
22 use rustc_session::cstore::DllImport;
23 use rustc_session::Session;
25 /// Helper for adding many files to an archive.
26 #[must_use = "must call build() to finish building the archive"]
27 pub(crate) struct LlvmArchiveBuilder<'a> {
29 additions: Vec<Addition>,
33 File { path: PathBuf, name_in_archive: String },
34 Archive { path: PathBuf, archive: ArchiveRO, skip: Box<dyn FnMut(&str) -> bool> },
38 fn path(&self) -> &Path {
40 Addition::File { path, .. } | Addition::Archive { path, .. } => path,
45 fn is_relevant_child(c: &Child<'_>) -> bool {
47 Some(name) => !name.contains("SYMDEF"),
52 /// Map machine type strings to values of LLVM's MachineTypes enum.
53 fn llvm_machine_type(cpu: &str) -> LLVMMachineType {
55 "x86_64" => LLVMMachineType::AMD64,
56 "x86" => LLVMMachineType::I386,
57 "aarch64" => LLVMMachineType::ARM64,
58 "arm" => LLVMMachineType::ARM,
59 _ => panic!("unsupported cpu type {}", cpu),
63 impl<'a> ArchiveBuilder<'a> for LlvmArchiveBuilder<'a> {
67 skip: Box<dyn FnMut(&str) -> bool + 'static>,
69 let archive_ro = match ArchiveRO::open(archive) {
71 Err(e) => return Err(io::Error::new(io::ErrorKind::Other, e)),
73 if self.additions.iter().any(|ar| ar.path() == archive) {
76 self.additions.push(Addition::Archive {
77 path: archive.to_path_buf(),
84 /// Adds an arbitrary file to this archive
85 fn add_file(&mut self, file: &Path) {
86 let name = file.file_name().unwrap().to_str().unwrap();
88 .push(Addition::File { path: file.to_path_buf(), name_in_archive: name.to_owned() });
91 /// Combine the provided files, rlibs, and native libraries into a single
93 fn build(mut self: Box<Self>, output: &Path) -> bool {
94 match self.build_with_llvm(output) {
95 Ok(any_members) => any_members,
96 Err(e) => self.sess.emit_fatal(ArchiveBuildFailure { error: e }),
101 pub struct LlvmArchiveBuilderBuilder;
103 impl ArchiveBuilderBuilder for LlvmArchiveBuilderBuilder {
104 fn new_archive_builder<'a>(&self, sess: &'a Session) -> Box<dyn ArchiveBuilder<'a> + 'a> {
105 if sess.target.arch == "wasm32" || sess.target.arch == "wasm64" {
106 Box::new(LlvmArchiveBuilder { sess, additions: Vec::new() })
108 Box::new(ArArchiveBuilder::new(sess, get_llvm_object_symbols))
112 fn create_dll_import_lib(
116 dll_imports: &[DllImport],
118 is_direct_dependency: bool,
120 let name_suffix = if is_direct_dependency { "_imports" } else { "_imports_indirect" };
122 let mut output_path: PathBuf = tmpdir.to_path_buf();
123 output_path.push(format!("{}{}", lib_name, name_suffix));
124 output_path.with_extension("lib")
127 let target = &sess.target;
128 let mingw_gnu_toolchain = common::is_mingw_gnu_toolchain(target);
130 let import_name_and_ordinal_vector: Vec<(String, Option<u16>)> = dll_imports
132 .map(|import: &DllImport| {
133 if sess.target.arch == "x86" {
135 common::i686_decorated_name(import, mingw_gnu_toolchain, false),
139 (import.name.to_string(), import.ordinal())
144 if mingw_gnu_toolchain {
145 // The binutils linker used on -windows-gnu targets cannot read the import
146 // libraries generated by LLVM: in our attempts, the linker produced an .EXE
147 // that loaded but crashed with an AV upon calling one of the imported
148 // functions. Therefore, use binutils to create the import library instead,
149 // by writing a .DEF file to the temp dir and calling binutils's dlltool.
151 tmpdir.join(format!("{}{}", lib_name, name_suffix)).with_extension("def");
153 let def_file_content = format!(
155 import_name_and_ordinal_vector
157 .map(|(name, ordinal)| {
159 Some(n) => format!("{} @{} NONAME", name, n),
163 .collect::<Vec<String>>()
167 match std::fs::write(&def_file_path, def_file_content) {
170 sess.emit_fatal(ErrorWritingDEFFile { error: e });
174 // --no-leading-underscore: For the `import_name_type` feature to work, we need to be
175 // able to control the *exact* spelling of each of the symbols that are being imported:
176 // hence we don't want `dlltool` adding leading underscores automatically.
177 let dlltool = find_binutils_dlltool(sess);
178 let result = std::process::Command::new(dlltool)
181 def_file_path.to_str().unwrap(),
185 output_path.to_str().unwrap(),
186 "--no-leading-underscore",
192 sess.emit_fatal(ErrorCallingDllTool { error: e });
194 Ok(output) if !output.status.success() => {
195 sess.emit_fatal(DlltoolFailImportLibrary {
196 stdout: String::from_utf8_lossy(&output.stdout),
197 stderr: String::from_utf8_lossy(&output.stderr),
203 // we've checked for \0 characters in the library name already
204 let dll_name_z = CString::new(lib_name).unwrap();
206 let output_path_z = rustc_fs_util::path_to_c_string(&output_path);
208 trace!("invoking LLVMRustWriteImportLibrary");
209 trace!(" dll_name {:#?}", dll_name_z);
210 trace!(" output_path {}", output_path.display());
215 .map(|import| import.name.to_string())
220 // All import names are Rust identifiers and therefore cannot contain \0 characters.
221 // FIXME: when support for #[link_name] is implemented, ensure that the import names
222 // still don't contain any \0 characters. Also need to check that the names don't
223 // contain substrings like " @" or "NONAME" that are keywords or otherwise reserved
224 // in definition files.
225 let cstring_import_name_and_ordinal_vector: Vec<(CString, Option<u16>)> =
226 import_name_and_ordinal_vector
228 .map(|(name, ordinal)| (CString::new(name).unwrap(), ordinal))
231 let ffi_exports: Vec<LLVMRustCOFFShortExport> = cstring_import_name_and_ordinal_vector
233 .map(|(name_z, ordinal)| LLVMRustCOFFShortExport::new(name_z.as_ptr(), *ordinal))
235 let result = unsafe {
236 crate::llvm::LLVMRustWriteImportLibrary(
238 output_path_z.as_ptr(),
239 ffi_exports.as_ptr(),
241 llvm_machine_type(&sess.target.arch) as u16,
242 !sess.target.is_like_msvc,
246 if result == crate::llvm::LLVMRustResult::Failure {
247 sess.emit_fatal(ErrorCreatingImportLibrary {
249 error: llvm::last_error().unwrap_or("unknown LLVM error".to_string()),
258 // The object crate doesn't know how to get symbols for LLVM bitcode and COFF bigobj files.
259 // As such we need to use LLVM for them.
260 #[deny(unsafe_op_in_unsafe_fn)]
261 fn get_llvm_object_symbols(
263 f: &mut dyn FnMut(&[u8]) -> io::Result<()>,
264 ) -> io::Result<bool> {
265 let is_bitcode = unsafe { llvm::LLVMRustIsBitcode(buf.as_ptr(), buf.len()) };
267 // COFF bigobj file, msvc LTO file or import library. See
268 // https://github.com/llvm/llvm-project/blob/453f27bc9/llvm/lib/BinaryFormat/Magic.cpp#L38-L51
269 let is_unsupported_windows_obj_file = buf.get(0..4) == Some(b"\0\0\xFF\xFF");
271 if is_bitcode || is_unsupported_windows_obj_file {
272 let mut state = Box::new(f);
275 llvm::LLVMRustGetSymbols(
278 &mut *state as *mut &mut _ as *mut c_void,
287 return Err(unsafe { *Box::from_raw(err as *mut io::Error) });
290 unsafe extern "C" fn callback(
292 symbol_name: *const c_char,
294 let f = unsafe { &mut *(state as *mut &mut dyn FnMut(&[u8]) -> io::Result<()>) };
295 match f(unsafe { CStr::from_ptr(symbol_name) }.to_bytes()) {
296 Ok(()) => std::ptr::null_mut(),
297 Err(err) => Box::into_raw(Box::new(err)) as *mut c_void,
301 unsafe extern "C" fn error_callback(error: *const c_char) -> *mut c_void {
302 let error = unsafe { CStr::from_ptr(error) };
303 Box::into_raw(Box::new(io::Error::new(
304 io::ErrorKind::Other,
305 format!("LLVM error: {}", error.to_string_lossy()),
309 get_native_object_symbols(buf, f)
313 impl<'a> LlvmArchiveBuilder<'a> {
314 fn build_with_llvm(&mut self, output: &Path) -> io::Result<bool> {
315 let kind = &*self.sess.target.archive_format;
317 .parse::<ArchiveKind>()
319 .unwrap_or_else(|kind| self.sess.emit_fatal(UnknownArchiveKind { kind }));
321 let mut additions = mem::take(&mut self.additions);
322 let mut strings = Vec::new();
323 let mut members = Vec::new();
325 let dst = CString::new(output.to_str().unwrap())?;
328 for addition in &mut additions {
330 Addition::File { path, name_in_archive } => {
331 let path = CString::new(path.to_str().unwrap())?;
332 let name = CString::new(name_in_archive.clone())?;
333 members.push(llvm::LLVMRustArchiveMemberNew(
341 Addition::Archive { archive, skip, .. } => {
342 for child in archive.iter() {
343 let child = child.map_err(string_to_io_error)?;
344 if !is_relevant_child(&child) {
347 let child_name = child.name().unwrap();
348 if skip(child_name) {
352 // It appears that LLVM's archive writer is a little
353 // buggy if the name we pass down isn't just the
354 // filename component, so chop that off here and
357 // See LLVM bug 25877 for more info.
359 Path::new(child_name).file_name().unwrap().to_str().unwrap();
360 let name = CString::new(child_name)?;
361 let m = llvm::LLVMRustArchiveMemberNew(
373 let r = llvm::LLVMRustWriteArchive(
375 members.len() as libc::size_t,
376 members.as_ptr() as *const &_,
380 let ret = if r.into_result().is_err() {
381 let err = llvm::LLVMRustGetLastError();
382 let msg = if err.is_null() {
383 "failed to write archive".into()
385 String::from_utf8_lossy(CStr::from_ptr(err).to_bytes())
387 Err(io::Error::new(io::ErrorKind::Other, msg))
389 Ok(!members.is_empty())
391 for member in members {
392 llvm::LLVMRustArchiveMemberFree(member);
399 fn string_to_io_error(s: String) -> io::Error {
400 io::Error::new(io::ErrorKind::Other, format!("bad archive: {}", s))
403 fn find_binutils_dlltool(sess: &Session) -> OsString {
404 assert!(sess.target.options.is_like_windows && !sess.target.options.is_like_msvc);
405 if let Some(dlltool_path) = &sess.opts.unstable_opts.dlltool {
406 return dlltool_path.clone().into_os_string();
409 let mut tool_name: OsString = if sess.host.arch != sess.target.arch {
410 // We are cross-compiling, so we need the tool with the prefix matching our target
411 if sess.target.arch == "x86" {
412 "i686-w64-mingw32-dlltool"
414 "x86_64-w64-mingw32-dlltool"
417 // We are not cross-compiling, so we just want `dlltool`
422 if sess.host.options.is_like_windows {
423 // If we're compiling on Windows, add the .exe suffix
424 tool_name.push(".exe");
427 // NOTE: it's not clear how useful it is to explicitly search PATH.
428 for dir in env::split_paths(&env::var_os("PATH").unwrap_or_default()) {
429 let full_path = dir.join(&tool_name);
430 if full_path.is_file() {
431 return full_path.into_os_string();
435 // The user didn't specify the location of the dlltool binary, and we weren't able
436 // to find the appropriate one on the PATH. Just return the name of the tool
437 // and let the invocation fail with a hopefully useful error message.