compiler/rustc_session/src/filesearch.rs

   1 //! A module for searching for libraries
   2
   3 pub use self::FileMatch::*;
   4
   5 use std::env;
   6 use std::fs;
   7 use std::iter::FromIterator;
   8 use std::path::{Path, PathBuf};
   9
  10 use crate::search_paths::{PathKind, SearchPath, SearchPathFile};
  11 use rustc_fs_util::fix_windows_verbatim_for_gcc;
  12 use tracing::debug;
  13
  14 #[derive(Copy, Clone)]
  15 pub enum FileMatch {
  16     FileMatches,
  17     FileDoesntMatch,
  18 }
  19
  20 #[derive(Clone)]
  21 pub struct FileSearch<'a> {
  22     sysroot: &'a Path,
  23     triple: &'a str,
  24     search_paths: &'a [SearchPath],
  25     tlib_path: &'a SearchPath,
  26     kind: PathKind,
  27 }
  28
  29 impl<'a> FileSearch<'a> {
  30     pub fn search_paths(&self) -> impl Iterator<Item = &'a SearchPath> {
  31         let kind = self.kind;
  32         self.search_paths
  33             .iter()
  34             .filter(move |sp| sp.kind.matches(kind))
  35             .chain(std::iter::once(self.tlib_path))
  36     }
  37
  38     pub fn get_lib_path(&self) -> PathBuf {
  39         make_target_lib_path(self.sysroot, self.triple)
  40     }
  41
  42     pub fn get_self_contained_lib_path(&self) -> PathBuf {
  43         self.get_lib_path().join("self-contained")
  44     }
  45
  46     pub fn search<F>(&self, mut pick: F)
  47     where
  48         F: FnMut(&SearchPathFile, PathKind) -> FileMatch,
  49     {
  50         for search_path in self.search_paths() {
  51             debug!("searching {}", search_path.dir.display());
  52             fn is_rlib(spf: &SearchPathFile) -> bool {
  53                 if let Some(f) = &spf.file_name_str { f.ends_with(".rlib") } else { false }
  54             }
  55             // Reading metadata out of rlibs is faster, and if we find both
  56             // an rlib and a dylib we only read one of the files of
  57             // metadata, so in the name of speed, bring all rlib files to
  58             // the front of the search list.
  59             let files1 = search_path.files.iter().filter(|spf| is_rlib(&spf));
  60             let files2 = search_path.files.iter().filter(|spf| !is_rlib(&spf));
  61             for spf in files1.chain(files2) {
  62                 debug!("testing {}", spf.path.display());
  63                 let maybe_picked = pick(spf, search_path.kind);
  64                 match maybe_picked {
  65                     FileMatches => {
  66                         debug!("picked {}", spf.path.display());
  67                     }
  68                     FileDoesntMatch => {
  69                         debug!("rejected {}", spf.path.display());
  70                     }
  71                 }
  72             }
  73         }
  74     }
  75
  76     pub fn new(
  77         sysroot: &'a Path,
  78         triple: &'a str,
  79         search_paths: &'a [SearchPath],
  80         tlib_path: &'a SearchPath,
  81         kind: PathKind,
  82     ) -> FileSearch<'a> {
  83         debug!("using sysroot = {}, triple = {}", sysroot.display(), triple);
  84         FileSearch { sysroot, triple, search_paths, tlib_path, kind }
  85     }
  86
  87     /// Returns just the directories within the search paths.
  88     pub fn search_path_dirs(&self) -> Vec<PathBuf> {
  89         self.search_paths().map(|sp| sp.dir.to_path_buf()).collect()
  90     }
  91 }
  92
  93 pub fn make_target_lib_path(sysroot: &Path, target_triple: &str) -> PathBuf {
  94     let rustlib_path = rustc_target::target_rustlib_path(sysroot, target_triple);
  95     PathBuf::from_iter([sysroot, Path::new(&rustlib_path), Path::new("lib")])
  96 }
  97
  98 /// This function checks if sysroot is found using env::args().next(), and if it
  99 /// is not found, uses env::current_exe() to imply sysroot.
 100 pub fn get_or_default_sysroot() -> PathBuf {
 101     // Follow symlinks.  If the resolved path is relative, make it absolute.
 102     fn canonicalize(path: PathBuf) -> PathBuf {
 103         let path = fs::canonicalize(&path).unwrap_or(path);
 104         // See comments on this target function, but the gist is that
 105         // gcc chokes on verbatim paths which fs::canonicalize generates
 106         // so we try to avoid those kinds of paths.
 107         fix_windows_verbatim_for_gcc(&path)
 108     }
 109
 110     // Use env::current_exe() to get the path of the executable following
 111     // symlinks/canonicalizing components.
 112     fn from_current_exe() -> PathBuf {
 113         match env::current_exe() {
 114             Ok(exe) => {
 115                 let mut p = canonicalize(exe);
 116                 p.pop();
 117                 p.pop();
 118                 p
 119             }
 120             Err(e) => panic!("failed to get current_exe: {}", e),
 121         }
 122     }
 123
 124     // Use env::args().next() to get the path of the executable without
 125     // following symlinks/canonicalizing any component. This makes the rustc
 126     // binary able to locate Rust libraries in systems using content-addressable
 127     // storage (CAS).
 128     fn from_env_args_next() -> Option<PathBuf> {
 129         match env::args_os().next() {
 130             Some(first_arg) => {
 131                 let mut p = PathBuf::from(first_arg);
 132
 133                 // Check if sysroot is found using env::args().next() only if the rustc in argv[0]
 134                 // is a symlink (see #79253). We might want to change/remove it to conform with
 135                 // https://www.gnu.org/prep/standards/standards.html#Finding-Program-Files in the
 136                 // future.
 137                 if fs::read_link(&p).is_err() {
 138                     // Path is not a symbolic link or does not exist.
 139                     return None;
 140                 }
 141
 142                 // Pop off `bin/rustc`, obtaining the suspected sysroot.
 143                 p.pop();
 144                 p.pop();
 145                 // Look for the target rustlib directory in the suspected sysroot.
 146                 let mut rustlib_path = rustc_target::target_rustlib_path(&p, "dummy");
 147                 rustlib_path.pop(); // pop off the dummy target.
 148                 if rustlib_path.exists() { Some(p) } else { None }
 149             }
 150             None => None,
 151         }
 152     }
 153
 154     // Check if sysroot is found using env::args().next(), and if is not found,
 155     // use env::current_exe() to imply sysroot.
 156     from_env_args_next().unwrap_or_else(from_current_exe)
 157 }