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