src/archive.rs

   1 //! Creation of ar archives like for the lib and staticlib crate type
   2
   3 use std::collections::BTreeMap;
   4 use std::fs::File;
   5 use std::io::{self, Read, Seek};
   6 use std::path::{Path, PathBuf};
   7
   8 use rustc_codegen_ssa::back::archive::ArchiveBuilder;
   9 use rustc_session::Session;
  10
  11 use object::read::archive::ArchiveFile;
  12 use object::{Object, ObjectSymbol, ReadCache};
  13
  14 #[derive(Debug)]
  15 enum ArchiveEntry {
  16     FromArchive { archive_index: usize, file_range: (u64, u64) },
  17     File(PathBuf),
  18 }
  19
  20 pub(crate) struct ArArchiveBuilder<'a> {
  21     sess: &'a Session,
  22     dst: PathBuf,
  23     use_gnu_style_archive: bool,
  24     no_builtin_ranlib: bool,
  25
  26     src_archives: Vec<File>,
  27     // Don't use `HashMap` here, as the order is important. `rust.metadata.bin` must always be at
  28     // the end of an archive for linkers to not get confused.
  29     entries: Vec<(Vec<u8>, ArchiveEntry)>,
  30 }
  31
  32 impl<'a> ArchiveBuilder<'a> for ArArchiveBuilder<'a> {
  33     fn new(sess: &'a Session, output: &Path, input: Option<&Path>) -> Self {
  34         let (src_archives, entries) = if let Some(input) = input {
  35             let read_cache = ReadCache::new(File::open(input).unwrap());
  36             let archive = ArchiveFile::parse(&read_cache).unwrap();
  37             let mut entries = Vec::new();
  38
  39             for entry in archive.members() {
  40                 let entry = entry.unwrap();
  41                 entries.push((
  42                     entry.name().to_vec(),
  43                     ArchiveEntry::FromArchive { archive_index: 0, file_range: entry.file_range() },
  44                 ));
  45             }
  46
  47             (vec![read_cache.into_inner()], entries)
  48         } else {
  49             (vec![], Vec::new())
  50         };
  51
  52         ArArchiveBuilder {
  53             sess,
  54             dst: output.to_path_buf(),
  55             use_gnu_style_archive: sess.target.archive_format == "gnu",
  56             // FIXME fix builtin ranlib on macOS
  57             no_builtin_ranlib: sess.target.is_like_osx,
  58
  59             src_archives,
  60             entries,
  61         }
  62     }
  63
  64     fn add_file(&mut self, file: &Path) {
  65         self.entries.push((
  66             file.file_name().unwrap().to_str().unwrap().to_string().into_bytes(),
  67             ArchiveEntry::File(file.to_owned()),
  68         ));
  69     }
  70
  71     fn add_archive<F>(&mut self, archive_path: &Path, mut skip: F) -> std::io::Result<()>
  72     where
  73         F: FnMut(&str) -> bool + 'static,
  74     {
  75         let read_cache = ReadCache::new(std::fs::File::open(&archive_path)?);
  76         let archive = ArchiveFile::parse(&read_cache).unwrap();
  77         let archive_index = self.src_archives.len();
  78
  79         for entry in archive.members() {
  80             let entry = entry.map_err(|err| io::Error::new(io::ErrorKind::InvalidData, err))?;
  81             let file_name = String::from_utf8(entry.name().to_vec())
  82                 .map_err(|err| io::Error::new(io::ErrorKind::InvalidData, err))?;
  83             if !skip(&file_name) {
  84                 self.entries.push((
  85                     file_name.into_bytes(),
  86                     ArchiveEntry::FromArchive { archive_index, file_range: entry.file_range() },
  87                 ));
  88             }
  89         }
  90
  91         self.src_archives.push(read_cache.into_inner());
  92         Ok(())
  93     }
  94
  95     fn build(mut self) {
  96         enum BuilderKind {
  97             Bsd(ar::Builder<File>),
  98             Gnu(ar::GnuBuilder<File>),
  99         }
 100
 101         let sess = self.sess;
 102
 103         let mut symbol_table = BTreeMap::new();
 104
 105         let mut entries = Vec::new();
 106
 107         for (entry_name, entry) in self.entries {
 108             // FIXME only read the symbol table of the object files to avoid having to keep all
 109             // object files in memory at once, or read them twice.
 110             let data = match entry {
 111                 ArchiveEntry::FromArchive { archive_index, file_range } => {
 112                     // FIXME read symbols from symtab
 113                     let src_read_cache = &mut self.src_archives[archive_index];
 114
 115                     src_read_cache.seek(io::SeekFrom::Start(file_range.0)).unwrap();
 116                     let mut data = std::vec::from_elem(0, usize::try_from(file_range.1).unwrap());
 117                     src_read_cache.read_exact(&mut data).unwrap();
 118
 119                     data
 120                 }
 121                 ArchiveEntry::File(file) => std::fs::read(file).unwrap_or_else(|err| {
 122                     sess.fatal(&format!(
 123                         "error while reading object file during archive building: {}",
 124                         err
 125                     ));
 126                 }),
 127             };
 128
 129             if !self.no_builtin_ranlib {
 130                 match object::File::parse(&*data) {
 131                     Ok(object) => {
 132                         symbol_table.insert(
 133                             entry_name.to_vec(),
 134                             object
 135                                 .symbols()
 136                                 .filter_map(|symbol| {
 137                                     if symbol.is_undefined() || symbol.is_local() {
 138                                         None
 139                                     } else {
 140                                         symbol.name().map(|name| name.as_bytes().to_vec()).ok()
 141                                     }
 142                                 })
 143                                 .collect::<Vec<_>>(),
 144                         );
 145                     }
 146                     Err(err) => {
 147                         let err = err.to_string();
 148                         if err == "Unknown file magic" {
 149                             // Not an object file; skip it.
 150                         } else {
 151                             sess.fatal(&format!(
 152                                 "error parsing `{}` during archive creation: {}",
 153                                 String::from_utf8_lossy(&entry_name),
 154                                 err
 155                             ));
 156                         }
 157                     }
 158                 }
 159             }
 160
 161             entries.push((entry_name, data));
 162         }
 163
 164         let mut builder = if self.use_gnu_style_archive {
 165             BuilderKind::Gnu(
 166                 ar::GnuBuilder::new(
 167                     File::create(&self.dst).unwrap_or_else(|err| {
 168                         sess.fatal(&format!(
 169                             "error opening destination during archive building: {}",
 170                             err
 171                         ));
 172                     }),
 173                     entries.iter().map(|(name, _)| name.clone()).collect(),
 174                     ar::GnuSymbolTableFormat::Size32,
 175                     symbol_table,
 176                 )
 177                 .unwrap(),
 178             )
 179         } else {
 180             BuilderKind::Bsd(
 181                 ar::Builder::new(
 182                     File::create(&self.dst).unwrap_or_else(|err| {
 183                         sess.fatal(&format!(
 184                             "error opening destination during archive building: {}",
 185                             err
 186                         ));
 187                     }),
 188                     symbol_table,
 189                 )
 190                 .unwrap(),
 191             )
 192         };
 193
 194         // Add all files
 195         for (entry_name, data) in entries.into_iter() {
 196             let header = ar::Header::new(entry_name, data.len() as u64);
 197             match builder {
 198                 BuilderKind::Bsd(ref mut builder) => builder.append(&header, &mut &*data).unwrap(),
 199                 BuilderKind::Gnu(ref mut builder) => builder.append(&header, &mut &*data).unwrap(),
 200             }
 201         }
 202
 203         // Finalize archive
 204         std::mem::drop(builder);
 205
 206         if self.no_builtin_ranlib {
 207             let ranlib = crate::toolchain::get_toolchain_binary(self.sess, "ranlib");
 208
 209             // Run ranlib to be able to link the archive
 210             let status = std::process::Command::new(ranlib)
 211                 .arg(self.dst)
 212                 .status()
 213                 .expect("Couldn't run ranlib");
 214
 215             if !status.success() {
 216                 self.sess.fatal(&format!("Ranlib exited with code {:?}", status.code()));
 217             }
 218         }
 219     }
 220
 221     fn inject_dll_import_lib(
 222         &mut self,
 223         _lib_name: &str,
 224         _dll_imports: &[rustc_session::cstore::DllImport],
 225         _tmpdir: &rustc_data_structures::temp_dir::MaybeTempDir,
 226     ) {
 227         bug!("injecting dll imports is not supported");
 228     }
 229 }