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.

Sign up for GitHub

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

Avoid a temporary file when processing macOS fat archives #105221

Merged
merged 2 commits into from
Dec 14, 2022
Merged

Avoid a temporary file when processing macOS fat archives #105221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
047c7cc
Remove macOS fat archive support from LlvmArchiveBuilder
alex Dec 3, 2022
bd8e476
Avoid a temporary file when processing macOS fat archives
alex Dec 3, 2022
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
14 changes: 4 additions & 10 deletions compiler/rustc_codegen_llvm/src/back/archive.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ use crate::errors::{
use crate::llvm::archive_ro::{ArchiveRO, Child};
use crate::llvm::{self, ArchiveKind, LLVMMachineType, LLVMRustCOFFShortExport};
use rustc_codegen_ssa::back::archive::{
get_native_object_symbols, try_extract_macho_fat_archive, ArArchiveBuilder,
ArchiveBuildFailure, ArchiveBuilder, ArchiveBuilderBuilder, UnknownArchiveKind,
get_native_object_symbols, ArArchiveBuilder, ArchiveBuildFailure, ArchiveBuilder,
ArchiveBuilderBuilder, UnknownArchiveKind,
};

use rustc_session::cstore::DllImport;
Expand Down Expand Up @@ -66,21 +66,15 @@ impl<'a> ArchiveBuilder<'a> for LlvmArchiveBuilder<'a> {
archive: &Path,
skip: Box<dyn FnMut(&str) -> bool + 'static>,
) -> io::Result<()> {
let mut archive = archive.to_path_buf();
if self.sess.target.llvm_target.contains("-apple-macosx") {
if let Some(new_archive) = try_extract_macho_fat_archive(&self.sess, &archive)? {
archive = new_archive
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should keep this for now in case we need to revert back from the rust rewrite to the original version on macOS due to a bug in the rust rewrite?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The LlvmArchiveWriter doesn't have a clean place to add this -- it doesn't track file_range, it just has a path.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. Would you mind waiting a week or so to make sure no issues pop up? r=me after that.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, that's fine

let archive_ro = match ArchiveRO::open(&archive) {
let archive_ro = match ArchiveRO::open(archive) {
Ok(ar) => ar,
Err(e) => return Err(io::Error::new(io::ErrorKind::Other, e)),
};
if self.additions.iter().any(|ar| ar.path() == archive) {
return Ok(());
}
self.additions.push(Addition::Archive {
path: archive,
path: archive.to_path_buf(),
archive: archive_ro,
skip: Box::new(skip),
});
Expand Down
70 changes: 34 additions & 36 deletions compiler/rustc_codegen_ssa/src/back/archive.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ use tempfile::Builder as TempFileBuilder;

use std::error::Error;
use std::fs::File;
use std::io::{self, Write};
use std::io;
use std::path::{Path, PathBuf};

// Re-exporting for rustc_codegen_llvm::back::archive
Expand Down Expand Up @@ -116,51 +116,42 @@ impl<'a> ArArchiveBuilder<'a> {
}
}

fn try_filter_fat_archs(
fn try_filter_fat_archs<'a>(
archs: object::read::Result<&[impl FatArch]>,
target_arch: object::Architecture,
archive_path: &Path,
archive_map_data: &[u8],
) -> io::Result<Option<PathBuf>> {
archive_map_data: &'a [u8],
) -> io::Result<Option<(&'a [u8], u64)>> {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This commit LGTM.

let archs = archs.map_err(|e| io::Error::new(io::ErrorKind::Other, e))?;

let desired = match archs.iter().filter(|a| a.architecture() == target_arch).next() {
Some(a) => a,
None => return Ok(None),
};

let (mut new_f, extracted_path) = tempfile::Builder::new()
.suffix(archive_path.file_name().unwrap())
.tempfile()?
.keep()
.unwrap();

new_f.write_all(
Ok(Some((
desired.data(archive_map_data).map_err(|e| io::Error::new(io::ErrorKind::Other, e))?,
)?;

Ok(Some(extracted_path))
desired.offset().into(),
)))
}

pub fn try_extract_macho_fat_archive(
pub fn try_extract_macho_fat_archive<'a>(
sess: &Session,
archive_path: &Path,
) -> io::Result<Option<PathBuf>> {
let archive_map = unsafe { Mmap::map(File::open(&archive_path)?)? };
archive_bytes: &'a [u8],
) -> io::Result<Option<(&'a [u8], u64)>> {
let target_arch = match sess.target.arch.as_ref() {
"aarch64" => object::Architecture::Aarch64,
"x86_64" => object::Architecture::X86_64,
_ => return Ok(None),
};

match object::macho::FatHeader::parse(&*archive_map) {
match object::macho::FatHeader::parse(archive_bytes) {
Ok(h) if h.magic.get(object::endian::BigEndian) == object::macho::FAT_MAGIC => {
let archs = object::macho::FatHeader::parse_arch32(&*archive_map);
try_filter_fat_archs(archs, target_arch, archive_path, &*archive_map)
let archs = object::macho::FatHeader::parse_arch32(archive_bytes);
try_filter_fat_archs(archs, target_arch, archive_bytes)
}
Ok(h) if h.magic.get(object::endian::BigEndian) == object::macho::FAT_MAGIC_64 => {
let archs = object::macho::FatHeader::parse_arch64(&*archive_map);
try_filter_fat_archs(archs, target_arch, archive_path, &*archive_map)
let archs = object::macho::FatHeader::parse_arch64(archive_bytes);
try_filter_fat_archs(archs, target_arch, archive_bytes)
}
// Not a FatHeader at all, just return None.
_ => Ok(None),
Expand All @@ -173,21 +164,24 @@ impl<'a> ArchiveBuilder<'a> for ArArchiveBuilder<'a> {
archive_path: &Path,
mut skip: Box<dyn FnMut(&str) -> bool + 'static>,
) -> io::Result<()> {
let mut archive_path = archive_path.to_path_buf();
if self.sess.target.llvm_target.contains("-apple-macosx") {
if let Some(new_archive_path) =
try_extract_macho_fat_archive(&self.sess, &archive_path)?
{
archive_path = new_archive_path
}
}

let archive_map = unsafe { Mmap::map(File::open(&archive_path)?)? };
if self.src_archives.iter().any(|archive| archive.0 == archive_path) {
return Ok(());
}

let archive_map = unsafe { Mmap::map(File::open(&archive_path)?)? };
let archive = ArchiveFile::parse(&*archive_map)
let (archive_bytes, offset) = if self.sess.target.llvm_target.contains("-apple-macosx") {
if let Some((sub_archive, archive_offset)) =
try_extract_macho_fat_archive(&self.sess, &*archive_map)?
{
(sub_archive, Some(archive_offset))
} else {
(&*archive_map, None)
}
} else {
(&*archive_map, None)
};

let archive = ArchiveFile::parse(&*archive_bytes)
.map_err(|err| io::Error::new(io::ErrorKind::InvalidData, err))?;
let archive_index = self.src_archives.len();

Expand All @@ -196,9 +190,13 @@ impl<'a> ArchiveBuilder<'a> for ArArchiveBuilder<'a> {
let file_name = String::from_utf8(entry.name().to_vec())
.map_err(|err| io::Error::new(io::ErrorKind::InvalidData, err))?;
if !skip(&file_name) {
let mut range = entry.file_range();
if let Some(offset) = offset {
range.0 += offset;
}
self.entries.push((
file_name.into_bytes(),
ArchiveEntry::FromArchive { archive_index, file_range: entry.file_range() },
ArchiveEntry::FromArchive { archive_index, file_range: range },
));
}
}
Expand Down