diff options
Diffstat (limited to 'src/tools/rust-analyzer/crates/base-db/src/input.rs')
-rw-r--r-- | src/tools/rust-analyzer/crates/base-db/src/input.rs | 792 |
1 files changed, 792 insertions, 0 deletions
diff --git a/src/tools/rust-analyzer/crates/base-db/src/input.rs b/src/tools/rust-analyzer/crates/base-db/src/input.rs new file mode 100644 index 000000000..9b5a10acf --- /dev/null +++ b/src/tools/rust-analyzer/crates/base-db/src/input.rs @@ -0,0 +1,792 @@ +//! This module specifies the input to rust-analyzer. In some sense, this is +//! **the** most important module, because all other fancy stuff is strictly +//! derived from this input. +//! +//! Note that neither this module, nor any other part of the analyzer's core do +//! actual IO. See `vfs` and `project_model` in the `rust-analyzer` crate for how +//! actual IO is done and lowered to input. + +use std::{fmt, iter::FromIterator, ops, panic::RefUnwindSafe, str::FromStr, sync::Arc}; + +use cfg::CfgOptions; +use rustc_hash::{FxHashMap, FxHashSet}; +use syntax::SmolStr; +use tt::Subtree; +use vfs::{file_set::FileSet, FileId, VfsPath}; + +/// Files are grouped into source roots. A source root is a directory on the +/// file systems which is watched for changes. Typically it corresponds to a +/// Rust crate. Source roots *might* be nested: in this case, a file belongs to +/// the nearest enclosing source root. Paths to files are always relative to a +/// source root, and the analyzer does not know the root path of the source root at +/// all. So, a file from one source root can't refer to a file in another source +/// root by path. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)] +pub struct SourceRootId(pub u32); + +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct SourceRoot { + /// Sysroot or crates.io library. + /// + /// Libraries are considered mostly immutable, this assumption is used to + /// optimize salsa's query structure + pub is_library: bool, + pub(crate) file_set: FileSet, +} + +impl SourceRoot { + pub fn new_local(file_set: FileSet) -> SourceRoot { + SourceRoot { is_library: false, file_set } + } + pub fn new_library(file_set: FileSet) -> SourceRoot { + SourceRoot { is_library: true, file_set } + } + pub fn path_for_file(&self, file: &FileId) -> Option<&VfsPath> { + self.file_set.path_for_file(file) + } + pub fn file_for_path(&self, path: &VfsPath) -> Option<&FileId> { + self.file_set.file_for_path(path) + } + pub fn iter(&self) -> impl Iterator<Item = FileId> + '_ { + self.file_set.iter() + } +} + +/// `CrateGraph` is a bit of information which turns a set of text files into a +/// number of Rust crates. +/// +/// Each crate is defined by the `FileId` of its root module, the set of enabled +/// `cfg` flags and the set of dependencies. +/// +/// Note that, due to cfg's, there might be several crates for a single `FileId`! +/// +/// For the purposes of analysis, a crate does not have a name. Instead, names +/// are specified on dependency edges. That is, a crate might be known under +/// different names in different dependent crates. +/// +/// Note that `CrateGraph` is build-system agnostic: it's a concept of the Rust +/// language proper, not a concept of the build system. In practice, we get +/// `CrateGraph` by lowering `cargo metadata` output. +/// +/// `CrateGraph` is `!Serialize` by design, see +/// <https://github.com/rust-lang/rust-analyzer/blob/master/docs/dev/architecture.md#serialization> +#[derive(Debug, Clone, Default /* Serialize, Deserialize */)] +pub struct CrateGraph { + arena: FxHashMap<CrateId, CrateData>, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] +pub struct CrateId(pub u32); + +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub struct CrateName(SmolStr); + +impl CrateName { + /// Creates a crate name, checking for dashes in the string provided. + /// Dashes are not allowed in the crate names, + /// hence the input string is returned as `Err` for those cases. + pub fn new(name: &str) -> Result<CrateName, &str> { + if name.contains('-') { + Err(name) + } else { + Ok(Self(SmolStr::new(name))) + } + } + + /// Creates a crate name, unconditionally replacing the dashes with underscores. + pub fn normalize_dashes(name: &str) -> CrateName { + Self(SmolStr::new(name.replace('-', "_"))) + } + + pub fn as_smol_str(&self) -> &SmolStr { + &self.0 + } +} + +impl fmt::Display for CrateName { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + self.0.fmt(f) + } +} + +impl ops::Deref for CrateName { + type Target = str; + fn deref(&self) -> &str { + &*self.0 + } +} + +/// Origin of the crates. It is used in emitting monikers. +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub enum CrateOrigin { + /// Crates that are from crates.io official registry, + CratesIo { repo: Option<String> }, + /// Crates that are provided by the language, like std, core, proc-macro, ... + Lang(LangCrateOrigin), +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub enum LangCrateOrigin { + Alloc, + Core, + ProcMacro, + Std, + Test, + Other, +} + +impl From<&str> for LangCrateOrigin { + fn from(s: &str) -> Self { + match s { + "alloc" => LangCrateOrigin::Alloc, + "core" => LangCrateOrigin::Core, + "proc-macro" => LangCrateOrigin::ProcMacro, + "std" => LangCrateOrigin::Std, + "test" => LangCrateOrigin::Test, + _ => LangCrateOrigin::Other, + } + } +} + +impl fmt::Display for LangCrateOrigin { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + let text = match self { + LangCrateOrigin::Alloc => "alloc", + LangCrateOrigin::Core => "core", + LangCrateOrigin::ProcMacro => "proc_macro", + LangCrateOrigin::Std => "std", + LangCrateOrigin::Test => "test", + LangCrateOrigin::Other => "other", + }; + f.write_str(text) + } +} + +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub struct CrateDisplayName { + // The name we use to display various paths (with `_`). + crate_name: CrateName, + // The name as specified in Cargo.toml (with `-`). + canonical_name: String, +} + +impl CrateDisplayName { + pub fn canonical_name(&self) -> &str { + &self.canonical_name + } + pub fn crate_name(&self) -> &CrateName { + &self.crate_name + } +} + +impl From<CrateName> for CrateDisplayName { + fn from(crate_name: CrateName) -> CrateDisplayName { + let canonical_name = crate_name.to_string(); + CrateDisplayName { crate_name, canonical_name } + } +} + +impl fmt::Display for CrateDisplayName { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + self.crate_name.fmt(f) + } +} + +impl ops::Deref for CrateDisplayName { + type Target = str; + fn deref(&self) -> &str { + &*self.crate_name + } +} + +impl CrateDisplayName { + pub fn from_canonical_name(canonical_name: String) -> CrateDisplayName { + let crate_name = CrateName::normalize_dashes(&canonical_name); + CrateDisplayName { crate_name, canonical_name } + } +} + +#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] +pub struct ProcMacroId(pub u32); + +#[derive(Copy, Clone, Eq, PartialEq, Debug, Hash)] +pub enum ProcMacroKind { + CustomDerive, + FuncLike, + Attr, +} + +pub trait ProcMacroExpander: fmt::Debug + Send + Sync + RefUnwindSafe { + fn expand( + &self, + subtree: &Subtree, + attrs: Option<&Subtree>, + env: &Env, + ) -> Result<Subtree, ProcMacroExpansionError>; +} + +pub enum ProcMacroExpansionError { + Panic(String), + /// Things like "proc macro server was killed by OOM". + System(String), +} + +pub type ProcMacroLoadResult = Result<Vec<ProcMacro>, String>; + +#[derive(Debug, Clone)] +pub struct ProcMacro { + pub name: SmolStr, + pub kind: ProcMacroKind, + pub expander: Arc<dyn ProcMacroExpander>, +} + +#[derive(Debug, Clone)] +pub struct CrateData { + pub root_file_id: FileId, + pub edition: Edition, + pub version: Option<String>, + /// A name used in the package's project declaration: for Cargo projects, + /// its `[package].name` can be different for other project types or even + /// absent (a dummy crate for the code snippet, for example). + /// + /// For purposes of analysis, crates are anonymous (only names in + /// `Dependency` matters), this name should only be used for UI. + pub display_name: Option<CrateDisplayName>, + pub cfg_options: CfgOptions, + pub potential_cfg_options: CfgOptions, + pub env: Env, + pub dependencies: Vec<Dependency>, + pub proc_macro: ProcMacroLoadResult, + pub origin: CrateOrigin, + pub is_proc_macro: bool, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] +pub enum Edition { + Edition2015, + Edition2018, + Edition2021, +} + +impl Edition { + pub const CURRENT: Edition = Edition::Edition2018; +} + +#[derive(Default, Debug, Clone, PartialEq, Eq)] +pub struct Env { + entries: FxHashMap<String, String>, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct Dependency { + pub crate_id: CrateId, + pub name: CrateName, + prelude: bool, +} + +impl Dependency { + pub fn new(name: CrateName, crate_id: CrateId) -> Self { + Self { name, crate_id, prelude: true } + } + + pub fn with_prelude(name: CrateName, crate_id: CrateId, prelude: bool) -> Self { + Self { name, crate_id, prelude } + } + + /// Whether this dependency is to be added to the depending crate's extern prelude. + pub fn is_prelude(&self) -> bool { + self.prelude + } +} + +impl CrateGraph { + pub fn add_crate_root( + &mut self, + root_file_id: FileId, + edition: Edition, + display_name: Option<CrateDisplayName>, + version: Option<String>, + cfg_options: CfgOptions, + potential_cfg_options: CfgOptions, + env: Env, + proc_macro: ProcMacroLoadResult, + is_proc_macro: bool, + origin: CrateOrigin, + ) -> CrateId { + let data = CrateData { + root_file_id, + edition, + version, + display_name, + cfg_options, + potential_cfg_options, + env, + proc_macro, + dependencies: Vec::new(), + origin, + is_proc_macro, + }; + let crate_id = CrateId(self.arena.len() as u32); + let prev = self.arena.insert(crate_id, data); + assert!(prev.is_none()); + crate_id + } + + pub fn add_dep( + &mut self, + from: CrateId, + dep: Dependency, + ) -> Result<(), CyclicDependenciesError> { + let _p = profile::span("add_dep"); + + // Check if adding a dep from `from` to `to` creates a cycle. To figure + // that out, look for a path in the *opposite* direction, from `to` to + // `from`. + if let Some(path) = self.find_path(&mut FxHashSet::default(), dep.crate_id, from) { + let path = path.into_iter().map(|it| (it, self[it].display_name.clone())).collect(); + let err = CyclicDependenciesError { path }; + assert!(err.from().0 == from && err.to().0 == dep.crate_id); + return Err(err); + } + + self.arena.get_mut(&from).unwrap().add_dep(dep); + Ok(()) + } + + pub fn is_empty(&self) -> bool { + self.arena.is_empty() + } + + pub fn iter(&self) -> impl Iterator<Item = CrateId> + '_ { + self.arena.keys().copied() + } + + /// Returns an iterator over all transitive dependencies of the given crate, + /// including the crate itself. + pub fn transitive_deps(&self, of: CrateId) -> impl Iterator<Item = CrateId> { + let mut worklist = vec![of]; + let mut deps = FxHashSet::default(); + + while let Some(krate) = worklist.pop() { + if !deps.insert(krate) { + continue; + } + + worklist.extend(self[krate].dependencies.iter().map(|dep| dep.crate_id)); + } + + deps.into_iter() + } + + /// Returns all transitive reverse dependencies of the given crate, + /// including the crate itself. + pub fn transitive_rev_deps(&self, of: CrateId) -> impl Iterator<Item = CrateId> { + let mut worklist = vec![of]; + let mut rev_deps = FxHashSet::default(); + rev_deps.insert(of); + + let mut inverted_graph = FxHashMap::<_, Vec<_>>::default(); + self.arena.iter().for_each(|(&krate, data)| { + data.dependencies + .iter() + .for_each(|dep| inverted_graph.entry(dep.crate_id).or_default().push(krate)) + }); + + while let Some(krate) = worklist.pop() { + if let Some(krate_rev_deps) = inverted_graph.get(&krate) { + krate_rev_deps + .iter() + .copied() + .filter(|&rev_dep| rev_deps.insert(rev_dep)) + .for_each(|rev_dep| worklist.push(rev_dep)); + } + } + + rev_deps.into_iter() + } + + /// Returns all crates in the graph, sorted in topological order (ie. dependencies of a crate + /// come before the crate itself). + pub fn crates_in_topological_order(&self) -> Vec<CrateId> { + let mut res = Vec::new(); + let mut visited = FxHashSet::default(); + + for krate in self.arena.keys().copied() { + go(self, &mut visited, &mut res, krate); + } + + return res; + + fn go( + graph: &CrateGraph, + visited: &mut FxHashSet<CrateId>, + res: &mut Vec<CrateId>, + source: CrateId, + ) { + if !visited.insert(source) { + return; + } + for dep in graph[source].dependencies.iter() { + go(graph, visited, res, dep.crate_id) + } + res.push(source) + } + } + + // FIXME: this only finds one crate with the given root; we could have multiple + pub fn crate_id_for_crate_root(&self, file_id: FileId) -> Option<CrateId> { + let (&crate_id, _) = + self.arena.iter().find(|(_crate_id, data)| data.root_file_id == file_id)?; + Some(crate_id) + } + + /// Extends this crate graph by adding a complete disjoint second crate + /// graph. + /// + /// The ids of the crates in the `other` graph are shifted by the return + /// amount. + pub fn extend(&mut self, other: CrateGraph) -> u32 { + let start = self.arena.len() as u32; + self.arena.extend(other.arena.into_iter().map(|(id, mut data)| { + let new_id = id.shift(start); + for dep in &mut data.dependencies { + dep.crate_id = dep.crate_id.shift(start); + } + (new_id, data) + })); + start + } + + fn find_path( + &self, + visited: &mut FxHashSet<CrateId>, + from: CrateId, + to: CrateId, + ) -> Option<Vec<CrateId>> { + if !visited.insert(from) { + return None; + } + + if from == to { + return Some(vec![to]); + } + + for dep in &self[from].dependencies { + let crate_id = dep.crate_id; + if let Some(mut path) = self.find_path(visited, crate_id, to) { + path.push(from); + return Some(path); + } + } + + None + } + + // Work around for https://github.com/rust-lang/rust-analyzer/issues/6038. + // As hacky as it gets. + pub fn patch_cfg_if(&mut self) -> bool { + let cfg_if = self.hacky_find_crate("cfg_if"); + let std = self.hacky_find_crate("std"); + match (cfg_if, std) { + (Some(cfg_if), Some(std)) => { + self.arena.get_mut(&cfg_if).unwrap().dependencies.clear(); + self.arena + .get_mut(&std) + .unwrap() + .dependencies + .push(Dependency::new(CrateName::new("cfg_if").unwrap(), cfg_if)); + true + } + _ => false, + } + } + + fn hacky_find_crate(&self, display_name: &str) -> Option<CrateId> { + self.iter().find(|it| self[*it].display_name.as_deref() == Some(display_name)) + } +} + +impl ops::Index<CrateId> for CrateGraph { + type Output = CrateData; + fn index(&self, crate_id: CrateId) -> &CrateData { + &self.arena[&crate_id] + } +} + +impl CrateId { + fn shift(self, amount: u32) -> CrateId { + CrateId(self.0 + amount) + } +} + +impl CrateData { + fn add_dep(&mut self, dep: Dependency) { + self.dependencies.push(dep) + } +} + +impl FromStr for Edition { + type Err = ParseEditionError; + + fn from_str(s: &str) -> Result<Self, Self::Err> { + let res = match s { + "2015" => Edition::Edition2015, + "2018" => Edition::Edition2018, + "2021" => Edition::Edition2021, + _ => return Err(ParseEditionError { invalid_input: s.to_string() }), + }; + Ok(res) + } +} + +impl fmt::Display for Edition { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.write_str(match self { + Edition::Edition2015 => "2015", + Edition::Edition2018 => "2018", + Edition::Edition2021 => "2021", + }) + } +} + +impl FromIterator<(String, String)> for Env { + fn from_iter<T: IntoIterator<Item = (String, String)>>(iter: T) -> Self { + Env { entries: FromIterator::from_iter(iter) } + } +} + +impl Env { + pub fn set(&mut self, env: &str, value: String) { + self.entries.insert(env.to_owned(), value); + } + + pub fn get(&self, env: &str) -> Option<String> { + self.entries.get(env).cloned() + } + + pub fn iter(&self) -> impl Iterator<Item = (&str, &str)> { + self.entries.iter().map(|(k, v)| (k.as_str(), v.as_str())) + } +} + +#[derive(Debug)] +pub struct ParseEditionError { + invalid_input: String, +} + +impl fmt::Display for ParseEditionError { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "invalid edition: {:?}", self.invalid_input) + } +} + +impl std::error::Error for ParseEditionError {} + +#[derive(Debug)] +pub struct CyclicDependenciesError { + path: Vec<(CrateId, Option<CrateDisplayName>)>, +} + +impl CyclicDependenciesError { + fn from(&self) -> &(CrateId, Option<CrateDisplayName>) { + self.path.first().unwrap() + } + fn to(&self) -> &(CrateId, Option<CrateDisplayName>) { + self.path.last().unwrap() + } +} + +impl fmt::Display for CyclicDependenciesError { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + let render = |(id, name): &(CrateId, Option<CrateDisplayName>)| match name { + Some(it) => format!("{}({:?})", it, id), + None => format!("{:?}", id), + }; + let path = self.path.iter().rev().map(render).collect::<Vec<String>>().join(" -> "); + write!( + f, + "cyclic deps: {} -> {}, alternative path: {}", + render(self.from()), + render(self.to()), + path + ) + } +} + +#[cfg(test)] +mod tests { + use crate::CrateOrigin; + + use super::{CfgOptions, CrateGraph, CrateName, Dependency, Edition::Edition2018, Env, FileId}; + + #[test] + fn detect_cyclic_dependency_indirect() { + let mut graph = CrateGraph::default(); + let crate1 = graph.add_crate_root( + FileId(1u32), + Edition2018, + None, + None, + CfgOptions::default(), + CfgOptions::default(), + Env::default(), + Ok(Vec::new()), + false, + CrateOrigin::CratesIo { repo: None }, + ); + let crate2 = graph.add_crate_root( + FileId(2u32), + Edition2018, + None, + None, + CfgOptions::default(), + CfgOptions::default(), + Env::default(), + Ok(Vec::new()), + false, + CrateOrigin::CratesIo { repo: None }, + ); + let crate3 = graph.add_crate_root( + FileId(3u32), + Edition2018, + None, + None, + CfgOptions::default(), + CfgOptions::default(), + Env::default(), + Ok(Vec::new()), + false, + CrateOrigin::CratesIo { repo: None }, + ); + assert!(graph + .add_dep(crate1, Dependency::new(CrateName::new("crate2").unwrap(), crate2)) + .is_ok()); + assert!(graph + .add_dep(crate2, Dependency::new(CrateName::new("crate3").unwrap(), crate3)) + .is_ok()); + assert!(graph + .add_dep(crate3, Dependency::new(CrateName::new("crate1").unwrap(), crate1)) + .is_err()); + } + + #[test] + fn detect_cyclic_dependency_direct() { + let mut graph = CrateGraph::default(); + let crate1 = graph.add_crate_root( + FileId(1u32), + Edition2018, + None, + None, + CfgOptions::default(), + CfgOptions::default(), + Env::default(), + Ok(Vec::new()), + false, + CrateOrigin::CratesIo { repo: None }, + ); + let crate2 = graph.add_crate_root( + FileId(2u32), + Edition2018, + None, + None, + CfgOptions::default(), + CfgOptions::default(), + Env::default(), + Ok(Vec::new()), + false, + CrateOrigin::CratesIo { repo: None }, + ); + assert!(graph + .add_dep(crate1, Dependency::new(CrateName::new("crate2").unwrap(), crate2)) + .is_ok()); + assert!(graph + .add_dep(crate2, Dependency::new(CrateName::new("crate2").unwrap(), crate2)) + .is_err()); + } + + #[test] + fn it_works() { + let mut graph = CrateGraph::default(); + let crate1 = graph.add_crate_root( + FileId(1u32), + Edition2018, + None, + None, + CfgOptions::default(), + CfgOptions::default(), + Env::default(), + Ok(Vec::new()), + false, + CrateOrigin::CratesIo { repo: None }, + ); + let crate2 = graph.add_crate_root( + FileId(2u32), + Edition2018, + None, + None, + CfgOptions::default(), + CfgOptions::default(), + Env::default(), + Ok(Vec::new()), + false, + CrateOrigin::CratesIo { repo: None }, + ); + let crate3 = graph.add_crate_root( + FileId(3u32), + Edition2018, + None, + None, + CfgOptions::default(), + CfgOptions::default(), + Env::default(), + Ok(Vec::new()), + false, + CrateOrigin::CratesIo { repo: None }, + ); + assert!(graph + .add_dep(crate1, Dependency::new(CrateName::new("crate2").unwrap(), crate2)) + .is_ok()); + assert!(graph + .add_dep(crate2, Dependency::new(CrateName::new("crate3").unwrap(), crate3)) + .is_ok()); + } + + #[test] + fn dashes_are_normalized() { + let mut graph = CrateGraph::default(); + let crate1 = graph.add_crate_root( + FileId(1u32), + Edition2018, + None, + None, + CfgOptions::default(), + CfgOptions::default(), + Env::default(), + Ok(Vec::new()), + false, + CrateOrigin::CratesIo { repo: None }, + ); + let crate2 = graph.add_crate_root( + FileId(2u32), + Edition2018, + None, + None, + CfgOptions::default(), + CfgOptions::default(), + Env::default(), + Ok(Vec::new()), + false, + CrateOrigin::CratesIo { repo: None }, + ); + assert!(graph + .add_dep( + crate1, + Dependency::new(CrateName::normalize_dashes("crate-name-with-dashes"), crate2) + ) + .is_ok()); + assert_eq!( + graph[crate1].dependencies, + vec![Dependency::new(CrateName::new("crate_name_with_dashes").unwrap(), crate2)] + ); + } +} |