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, try_extract_macho_fat_archive, ArArchiveBuilder,
19 ArchiveBuildFailure, ArchiveBuilder, 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 mut archive = archive.to_path_buf();
70 if self.sess.target.llvm_target.contains("-apple-macosx") {
71 if let Some(new_archive) = try_extract_macho_fat_archive(&self.sess, &archive)? {
75 let archive_ro = match ArchiveRO::open(&archive) {
77 Err(e) => return Err(io::Error::new(io::ErrorKind::Other, e)),
79 if self.additions.iter().any(|ar| ar.path() == archive) {
82 self.additions.push(Addition::Archive {
90 /// Adds an arbitrary file to this archive
91 fn add_file(&mut self, file: &Path) {
92 let name = file.file_name().unwrap().to_str().unwrap();
94 .push(Addition::File { path: file.to_path_buf(), name_in_archive: name.to_owned() });
97 /// Combine the provided files, rlibs, and native libraries into a single
99 fn build(mut self: Box<Self>, output: &Path) -> bool {
100 match self.build_with_llvm(output) {
101 Ok(any_members) => any_members,
102 Err(e) => self.sess.emit_fatal(ArchiveBuildFailure { error: e }),
107 pub struct LlvmArchiveBuilderBuilder;
109 impl ArchiveBuilderBuilder for LlvmArchiveBuilderBuilder {
110 fn new_archive_builder<'a>(&self, sess: &'a Session) -> Box<dyn ArchiveBuilder<'a> + 'a> {
111 if sess.target.arch == "wasm32" || sess.target.arch == "wasm64" {
112 Box::new(LlvmArchiveBuilder { sess, additions: Vec::new() })
114 Box::new(ArArchiveBuilder::new(sess, get_llvm_object_symbols))
118 fn create_dll_import_lib(
122 dll_imports: &[DllImport],
124 is_direct_dependency: bool,
126 let name_suffix = if is_direct_dependency { "_imports" } else { "_imports_indirect" };
128 let mut output_path: PathBuf = tmpdir.to_path_buf();
129 output_path.push(format!("{}{}", lib_name, name_suffix));
130 output_path.with_extension("lib")
133 let target = &sess.target;
134 let mingw_gnu_toolchain = common::is_mingw_gnu_toolchain(target);
136 let import_name_and_ordinal_vector: Vec<(String, Option<u16>)> = dll_imports
138 .map(|import: &DllImport| {
139 if sess.target.arch == "x86" {
141 common::i686_decorated_name(import, mingw_gnu_toolchain, false),
145 (import.name.to_string(), import.ordinal())
150 if mingw_gnu_toolchain {
151 // The binutils linker used on -windows-gnu targets cannot read the import
152 // libraries generated by LLVM: in our attempts, the linker produced an .EXE
153 // that loaded but crashed with an AV upon calling one of the imported
154 // functions. Therefore, use binutils to create the import library instead,
155 // by writing a .DEF file to the temp dir and calling binutils's dlltool.
157 tmpdir.join(format!("{}{}", lib_name, name_suffix)).with_extension("def");
159 let def_file_content = format!(
161 import_name_and_ordinal_vector
163 .map(|(name, ordinal)| {
165 Some(n) => format!("{} @{} NONAME", name, n),
169 .collect::<Vec<String>>()
173 match std::fs::write(&def_file_path, def_file_content) {
176 sess.emit_fatal(ErrorWritingDEFFile { error: e });
180 // --no-leading-underscore: For the `import_name_type` feature to work, we need to be
181 // able to control the *exact* spelling of each of the symbols that are being imported:
182 // hence we don't want `dlltool` adding leading underscores automatically.
183 let dlltool = find_binutils_dlltool(sess);
184 let result = std::process::Command::new(dlltool)
187 def_file_path.to_str().unwrap(),
191 output_path.to_str().unwrap(),
192 "--no-leading-underscore",
198 sess.emit_fatal(ErrorCallingDllTool { error: e });
200 Ok(output) if !output.status.success() => {
201 sess.emit_fatal(DlltoolFailImportLibrary {
202 stdout: String::from_utf8_lossy(&output.stdout),
203 stderr: String::from_utf8_lossy(&output.stderr),
209 // we've checked for \0 characters in the library name already
210 let dll_name_z = CString::new(lib_name).unwrap();
212 let output_path_z = rustc_fs_util::path_to_c_string(&output_path);
214 trace!("invoking LLVMRustWriteImportLibrary");
215 trace!(" dll_name {:#?}", dll_name_z);
216 trace!(" output_path {}", output_path.display());
221 .map(|import| import.name.to_string())
226 // All import names are Rust identifiers and therefore cannot contain \0 characters.
227 // FIXME: when support for #[link_name] is implemented, ensure that the import names
228 // still don't contain any \0 characters. Also need to check that the names don't
229 // contain substrings like " @" or "NONAME" that are keywords or otherwise reserved
230 // in definition files.
231 let cstring_import_name_and_ordinal_vector: Vec<(CString, Option<u16>)> =
232 import_name_and_ordinal_vector
234 .map(|(name, ordinal)| (CString::new(name).unwrap(), ordinal))
237 let ffi_exports: Vec<LLVMRustCOFFShortExport> = cstring_import_name_and_ordinal_vector
239 .map(|(name_z, ordinal)| LLVMRustCOFFShortExport::new(name_z.as_ptr(), *ordinal))
241 let result = unsafe {
242 crate::llvm::LLVMRustWriteImportLibrary(
244 output_path_z.as_ptr(),
245 ffi_exports.as_ptr(),
247 llvm_machine_type(&sess.target.arch) as u16,
248 !sess.target.is_like_msvc,
252 if result == crate::llvm::LLVMRustResult::Failure {
253 sess.emit_fatal(ErrorCreatingImportLibrary {
255 error: llvm::last_error().unwrap_or("unknown LLVM error".to_string()),
264 // The object crate doesn't know how to get symbols for LLVM bitcode and COFF bigobj files.
265 // As such we need to use LLVM for them.
266 #[deny(unsafe_op_in_unsafe_fn)]
267 fn get_llvm_object_symbols(
269 f: &mut dyn FnMut(&[u8]) -> io::Result<()>,
270 ) -> io::Result<bool> {
271 let is_bitcode = unsafe { llvm::LLVMRustIsBitcode(buf.as_ptr(), buf.len()) };
273 // COFF bigobj file, msvc LTO file or import library. See
274 // https://github.com/llvm/llvm-project/blob/453f27bc9/llvm/lib/BinaryFormat/Magic.cpp#L38-L51
275 let is_unsupported_windows_obj_file = buf.get(0..4) == Some(b"\0\0\xFF\xFF");
277 if is_bitcode || is_unsupported_windows_obj_file {
278 let mut state = Box::new(f);
281 llvm::LLVMRustGetSymbols(
284 &mut *state as *mut &mut _ as *mut c_void,
293 return Err(unsafe { *Box::from_raw(err as *mut io::Error) });
296 unsafe extern "C" fn callback(
298 symbol_name: *const c_char,
300 let f = unsafe { &mut *(state as *mut &mut dyn FnMut(&[u8]) -> io::Result<()>) };
301 match f(unsafe { CStr::from_ptr(symbol_name) }.to_bytes()) {
302 Ok(()) => std::ptr::null_mut(),
303 Err(err) => Box::into_raw(Box::new(err)) as *mut c_void,
307 unsafe extern "C" fn error_callback(error: *const c_char) -> *mut c_void {
308 let error = unsafe { CStr::from_ptr(error) };
309 Box::into_raw(Box::new(io::Error::new(
310 io::ErrorKind::Other,
311 format!("LLVM error: {}", error.to_string_lossy()),
315 get_native_object_symbols(buf, f)
319 impl<'a> LlvmArchiveBuilder<'a> {
320 fn build_with_llvm(&mut self, output: &Path) -> io::Result<bool> {
321 let kind = &*self.sess.target.archive_format;
323 .parse::<ArchiveKind>()
325 .unwrap_or_else(|kind| self.sess.emit_fatal(UnknownArchiveKind { kind }));
327 let mut additions = mem::take(&mut self.additions);
328 let mut strings = Vec::new();
329 let mut members = Vec::new();
331 let dst = CString::new(output.to_str().unwrap())?;
334 for addition in &mut additions {
336 Addition::File { path, name_in_archive } => {
337 let path = CString::new(path.to_str().unwrap())?;
338 let name = CString::new(name_in_archive.clone())?;
339 members.push(llvm::LLVMRustArchiveMemberNew(
347 Addition::Archive { archive, skip, .. } => {
348 for child in archive.iter() {
349 let child = child.map_err(string_to_io_error)?;
350 if !is_relevant_child(&child) {
353 let child_name = child.name().unwrap();
354 if skip(child_name) {
358 // It appears that LLVM's archive writer is a little
359 // buggy if the name we pass down isn't just the
360 // filename component, so chop that off here and
363 // See LLVM bug 25877 for more info.
365 Path::new(child_name).file_name().unwrap().to_str().unwrap();
366 let name = CString::new(child_name)?;
367 let m = llvm::LLVMRustArchiveMemberNew(
379 let r = llvm::LLVMRustWriteArchive(
381 members.len() as libc::size_t,
382 members.as_ptr() as *const &_,
386 let ret = if r.into_result().is_err() {
387 let err = llvm::LLVMRustGetLastError();
388 let msg = if err.is_null() {
389 "failed to write archive".into()
391 String::from_utf8_lossy(CStr::from_ptr(err).to_bytes())
393 Err(io::Error::new(io::ErrorKind::Other, msg))
395 Ok(!members.is_empty())
397 for member in members {
398 llvm::LLVMRustArchiveMemberFree(member);
405 fn string_to_io_error(s: String) -> io::Error {
406 io::Error::new(io::ErrorKind::Other, format!("bad archive: {}", s))
409 fn find_binutils_dlltool(sess: &Session) -> OsString {
410 assert!(sess.target.options.is_like_windows && !sess.target.options.is_like_msvc);
411 if let Some(dlltool_path) = &sess.opts.unstable_opts.dlltool {
412 return dlltool_path.clone().into_os_string();
415 let mut tool_name: OsString = if sess.host.arch != sess.target.arch {
416 // We are cross-compiling, so we need the tool with the prefix matching our target
417 if sess.target.arch == "x86" {
418 "i686-w64-mingw32-dlltool"
420 "x86_64-w64-mingw32-dlltool"
423 // We are not cross-compiling, so we just want `dlltool`
428 if sess.host.options.is_like_windows {
429 // If we're compiling on Windows, add the .exe suffix
430 tool_name.push(".exe");
433 // NOTE: it's not clear how useful it is to explicitly search PATH.
434 for dir in env::split_paths(&env::var_os("PATH").unwrap_or_default()) {
435 let full_path = dir.join(&tool_name);
436 if full_path.is_file() {
437 return full_path.into_os_string();
441 // The user didn't specify the location of the dlltool binary, and we weren't able
442 // to find the appropriate one on the PATH. Just return the name of the tool
443 // and let the invocation fail with a hopefully useful error message.