elfpak-core 0.5.4

//! The source filesystem, abstracted behind `--root`.
//!
//! The source root is treated as strictly read-only, and as the logical `/` of
//! the target system. Symlinks are followed *logically* (inside the root) so a
//! sysroot can be analyzed without any chance of escaping to the host.

use crate::{
    elf::ElfMetadata,
    error::{Error, Result, io},
};
use std::{
    collections::HashMap,
    path::{Component, Path, PathBuf},
};

/// How many symlinks may be traversed while resolving one logical path.
///
/// glibc's own limit is `SYMLOOP_MAX` (40 on Linux); matching it means a path
/// that resolves here is a path the loader would also resolve.
const SYMLINK_HOPS_MAX: usize = 40;

/// Upper bound on the components still waiting to be walked. Each symlink hop
/// can push the components of its target, so a pathological sysroot could grow
/// this list without ever repeating a link; the bound turns that into an error
/// rather than into memory growth.
const PENDING_COMPONENTS_MAX: usize = 1024;

/// A symlink observed while resolving a logical path.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SymlinkEntry {
    /// Logical location of the link itself, e.g. `/lib/x86_64-linux-gnu/libfoo.so.1`.
    pub logical: PathBuf,
    /// Raw link target, verbatim, so the relationship is preserved on output.
    pub target: PathBuf,
}

/// A logical path resolved to a real file inside the source root.
#[derive(Debug, Clone)]
pub struct Resolved {
    /// Logical path after following symlinks, e.g. `/usr/lib/.../libfoo.so.1.4.2`.
    pub logical: PathBuf,
    /// Host path of that file (source root prepended).
    pub host: PathBuf,
    /// Symlinks traversed on the way, in traversal order.
    pub links: Vec<SymlinkEntry>,
    pub kind: EntryKind,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum EntryKind {
    File,
    Directory,
    Other,
}

#[derive(Debug, Clone)]
pub struct SourceRoot {
    path: PathBuf,
}

impl SourceRoot {
    pub fn new(path: impl Into<PathBuf>) -> SourceRoot {
        SourceRoot { path: path.into() }
    }

    pub fn path(&self) -> &Path {
        &self.path
    }

    /// Map a logical path onto the host without following symlinks.
    pub fn host_path(&self, logical: &Path) -> PathBuf {
        crate::paths::join_under(&self.path, logical)
    }

    /// Resolve a logical path, following symlinks within the root.
    ///
    /// Returns `Ok(None)` when the path does not exist. Anything else — an
    /// unreadable directory, a component that is not a directory — is an error,
    /// because a caller reaching this way named the path. Use [`probe`] for a
    /// candidate the caller only guessed at.
    ///
    /// [`probe`]: SourceRoot::probe
    pub fn resolve(&self, logical: &Path) -> Result<Option<Resolved>> {
        self.walk(logical, Absence::NotFoundOnly)
    }

    /// As [`resolve`], but every failure to stat a component answers "nothing
    /// usable here".
    ///
    /// This is what a library lookup needs: glibc's `open_path` treats each
    /// failed candidate the same way and moves on to the next directory, so a
    /// stale search-path entry naming a regular file, or a directory this
    /// process cannot enter, must not fail a build the loader would complete.
    ///
    /// [`resolve`]: SourceRoot::resolve
    pub fn probe(&self, logical: &Path) -> Result<Option<Resolved>> {
        self.walk(logical, Absence::AnyFailureToStat)
    }

    fn walk(&self, logical: &Path, absence: Absence) -> Result<Option<Resolved>> {
        // Deliberately not normalized first: the kernel resolves `..` against
        // what the preceding components actually resolved to, so collapsing it
        // lexically would walk past a symlinked parent into a different
        // directory. The walk below pops `current`, which is that behavior.
        let mut pending = components_reversed(logical);
        let mut current = PathBuf::from("/");
        let mut links: Vec<SymlinkEntry> = Vec::new();
        let mut hops = 0usize;

        while let Some(component) = pending.pop() {
            if component == ".." {
                current.pop();
                continue;
            }
            if component == "." {
                continue;
            }

            let next_logical = current.join(&component);
            let host = self.host_path(&next_logical);
            let Some(metadata) = symlink_metadata_optional(&host, absence)? else {
                return Ok(None);
            };
            if !metadata.is_symlink() {
                current = next_logical;
                continue;
            }

            // Each hop consumes a component and is counted, so a chain of links
            // cannot walk forever.
            if hops == SYMLINK_HOPS_MAX || pending.len() > PENDING_COMPONENTS_MAX {
                return Err(Error::SymlinkLoop {
                    path: logical.to_path_buf(),
                });
            }
            hops += 1;

            let target = std::fs::read_link(&host).map_err(|e| io(&host, e))?;
            links.push(SymlinkEntry {
                logical: next_logical,
                target: target.clone(),
            });
            if target.is_absolute() {
                current = PathBuf::from("/");
            }
            pending.extend(components_reversed(&target));
        }

        self.describe(current, links, absence)
    }

    /// Stat the destination a walk arrived at, without following any further.
    fn describe(
        &self,
        logical: PathBuf,
        links: Vec<SymlinkEntry>,
        absence: Absence,
    ) -> Result<Option<Resolved>> {
        assert!(logical.is_absolute());

        let host = self.host_path(&logical);
        let Some(metadata) = metadata_optional(&host, absence)? else {
            return Ok(None);
        };
        let kind = if metadata.is_dir() {
            EntryKind::Directory
        } else if metadata.is_file() {
            EntryKind::File
        } else {
            EntryKind::Other
        };
        Ok(Some(Resolved {
            logical,
            host,
            links,
            kind,
        }))
    }

    /// Read a file identified by a logical path.
    pub fn read(&self, logical: &Path) -> Result<Option<Vec<u8>>> {
        self.read_bounded(logical, usize::MAX)
    }

    /// As [`SourceRoot::read`], but reading at most `limit_bytes`.
    ///
    /// A file in the source filesystem is as large as that filesystem says, so
    /// anything read to decide something small — a configuration file naming a
    /// few directories — says how much of it it is willing to look at. Content
    /// past the limit is truncated rather than being an error: the reader's
    /// answer is a hint, and a partial one beats failing the build.
    pub fn read_bounded(&self, logical: &Path, limit_bytes: usize) -> Result<Option<Vec<u8>>> {
        use std::io::Read;

        let Some(resolved) = self.resolve(logical)? else {
            return Ok(None);
        };
        if resolved.kind != EntryKind::File {
            return Ok(None);
        }
        let file = std::fs::File::open(&resolved.host).map_err(|e| io(&resolved.host, e))?;
        let mut bytes = Vec::new();
        file.take(limit_bytes as u64)
            .read_to_end(&mut bytes)
            .map_err(|e| io(&resolved.host, e))?;
        Ok(Some(bytes))
    }

    pub fn exists(&self, logical: &Path) -> bool {
        matches!(self.probe(logical), Ok(Some(_)))
    }

    pub fn is_dir(&self, logical: &Path) -> bool {
        matches!(self.probe(logical), Ok(Some(r)) if r.kind == EntryKind::Directory)
    }

    /// Directory entries (names only), sorted for deterministic output.
    pub fn read_dir(&self, logical: &Path) -> Result<Vec<std::ffi::OsString>> {
        let host = match self.resolve(logical)? {
            Some(resolved) if resolved.kind == EntryKind::Directory => resolved.host,
            _ => return Ok(Vec::new()),
        };
        let mut names = Vec::new();
        for entry in std::fs::read_dir(&host).map_err(|e| io(&host, e))? {
            let entry = entry.map_err(|e| io(&host, e))?;
            names.push(entry.file_name());
        }
        // Readdir order differs between filesystems; sorting is what makes two
        // runs over the same tree produce the same bundle.
        names.sort();
        Ok(names)
    }
}

/// Path components in pop order, i.e. reversed, with `..` kept as a component
/// so that the walk resolves it against what it has already traversed.
fn components_reversed(path: &Path) -> Vec<std::ffi::OsString> {
    path.components()
        .filter_map(|c| match c {
            Component::Normal(part) => Some(part.to_os_string()),
            Component::ParentDir => Some(std::ffi::OsString::from("..")),
            Component::RootDir | Component::CurDir | Component::Prefix(_) => None,
        })
        .rev()
        .collect()
}

/// Which stat failures a walk reports as "not there" rather than as an error.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Absence {
    /// Only a genuinely missing path. Anything else is worth telling the caller
    /// about, because the caller named this path.
    NotFoundOnly,
    /// Any failure to stat. A lookup is asking "is it here?", and every answer
    /// other than yes means try the next directory.
    AnyFailureToStat,
}

impl Absence {
    fn covers(self, error: &std::io::Error) -> bool {
        use std::io::ErrorKind;

        match self {
            Absence::NotFoundOnly => error.kind() == ErrorKind::NotFound,
            Absence::AnyFailureToStat => matches!(
                error.kind(),
                ErrorKind::NotFound
                    | ErrorKind::NotADirectory
                    | ErrorKind::PermissionDenied
                    | ErrorKind::InvalidFilename
            ),
        }
    }
}

/// `None` means there is nothing usable at the path. Any error `absence` does
/// not cover is propagated.
fn symlink_metadata_optional(host: &Path, absence: Absence) -> Result<Option<std::fs::Metadata>> {
    match std::fs::symlink_metadata(host) {
        Ok(metadata) => Ok(Some(metadata)),
        Err(e) if absence.covers(&e) => Ok(None),
        Err(e) => Err(io(host, e)),
    }
}

/// As [`symlink_metadata_optional`], but following a final symlink.
fn metadata_optional(host: &Path, absence: Absence) -> Result<Option<std::fs::Metadata>> {
    match std::fs::metadata(host) {
        Ok(metadata) => Ok(Some(metadata)),
        Err(e) if absence.covers(&e) => Ok(None),
        Err(e) => Err(io(host, e)),
    }
}

/// Parses each ELF object at most once, keyed by host path.
#[derive(Debug, Default)]
pub struct ElfCache {
    entries: HashMap<PathBuf, Option<ElfMetadata>>,
}

impl ElfCache {
    pub fn new() -> ElfCache {
        ElfCache::default()
    }

    /// Parse `host` as ELF. `Ok(None)` means the file exists but is not a usable
    /// ELF object.
    pub fn get(&mut self, host: &Path) -> Result<Option<ElfMetadata>> {
        if let Some(cached) = self.entries.get(host) {
            return Ok(cached.clone());
        }
        let parsed = match ElfMetadata::parse_file(host) {
            Ok(metadata) => Some(metadata),
            Err(Error::NotElf { .. }) | Err(Error::Elf { .. }) => None,
            Err(e) => return Err(e),
        };
        self.entries.insert(host.to_path_buf(), parsed.clone());
        Ok(parsed)
    }

    /// Like [`ElfCache::get`], but a parse failure is an error rather than `None`.
    pub fn require(&mut self, host: &Path) -> Result<ElfMetadata> {
        match self.get(host)? {
            Some(metadata) => Ok(metadata),
            None => ElfMetadata::parse_file(host),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn sysroot() -> (tempfile::TempDir, SourceRoot) {
        let temp = tempfile::tempdir().expect("tempdir");
        let root = SourceRoot::new(temp.path());
        (temp, root)
    }

    /// The kernel applies `..` to what the preceding component resolved to, so
    /// `link/../lib` depends on where `link` points. Collapsing it lexically
    /// would look in the link's own parent instead.
    #[test]
    fn parent_components_are_applied_after_symlinks() {
        let (temp, root) = sysroot();
        std::fs::create_dir_all(temp.path().join("real/sub")).unwrap();
        std::fs::create_dir_all(temp.path().join("real/lib")).unwrap();
        std::fs::create_dir_all(temp.path().join("lib")).unwrap();
        std::fs::write(temp.path().join("real/lib/libbase.so.1"), b"right").unwrap();
        std::fs::write(temp.path().join("lib/libbase.so.1"), b"wrong").unwrap();
        std::os::unix::fs::symlink("real/sub", temp.path().join("link")).unwrap();

        let resolved = root
            .resolve(Path::new("/link/../lib/libbase.so.1"))
            .unwrap()
            .expect("resolves through the symlink");
        assert_eq!(resolved.logical, Path::new("/real/lib/libbase.so.1"));
        assert_eq!(std::fs::read(&resolved.host).unwrap(), b"right");
    }

    /// A stale search-path entry naming a regular file is `ENOTDIR`, which the
    /// loader treats as "not here" and walks past.
    #[test]
    fn a_non_directory_component_is_absent_rather_than_an_error() {
        let (temp, root) = sysroot();
        std::fs::write(temp.path().join("notadir"), b"file").unwrap();

        assert!(
            root.probe(Path::new("/notadir/libbase.so.1"))
                .unwrap()
                .is_none()
        );
        assert!(!root.exists(Path::new("/notadir/libbase.so.1")));
        // A path the caller named keeps its real error.
        let error = root
            .resolve(Path::new("/notadir/libbase.so.1"))
            .expect_err("a named path reports why it could not be read");
        assert_eq!(error.code(), "E1000");
    }

    #[test]
    fn a_symlink_chain_longer_than_the_loader_allows_is_an_error() {
        let (temp, root) = sysroot();
        for hop in 0..=SYMLINK_HOPS_MAX {
            std::os::unix::fs::symlink(
                format!("link{}", hop + 1),
                temp.path().join(format!("link{hop}")),
            )
            .unwrap();
        }

        let error = root.resolve(Path::new("/link0")).unwrap_err();
        assert_eq!(error.code(), "E3003");
    }
}