1 //! Handles lowering of build-system specific workspace information (`cargo
2 //! metadata` or `rust-project.json`) into representation stored in the salsa
3 //! database -- `CrateGraph`.
5 use std::{collections::VecDeque, fmt, fs, path::Path, process::Command};
7 use anyhow::{Context, Result};
8 use base_db::{CrateDisplayName, CrateGraph, CrateId, CrateName, Edition, Env, FileId, ProcMacro};
9 use cargo_workspace::DepKind;
11 use paths::{AbsPath, AbsPathBuf};
12 use proc_macro_api::ProcMacroClient;
13 use rustc_hash::{FxHashMap, FxHashSet};
16 build_data::{BuildDataResult, PackageBuildData, WorkspaceBuildData},
20 sysroot::SysrootCrate,
21 utf8_stdout, BuildDataCollector, CargoConfig, CargoWorkspace, ProjectJson, ProjectManifest,
25 /// `PackageRoot` describes a package root folder.
26 /// Which may be an external dependency, or a member of
27 /// the current workspace.
28 #[derive(Debug, Clone, Eq, PartialEq, Hash)]
29 pub struct PackageRoot {
30 /// Is a member of the current workspace
32 pub include: Vec<AbsPathBuf>,
33 pub exclude: Vec<AbsPathBuf>,
36 #[derive(Clone, Eq, PartialEq)]
37 pub enum ProjectWorkspace {
38 /// Project workspace was discovered by running `cargo metadata` and `rustc --print sysroot`.
40 cargo: CargoWorkspace,
42 rustc: Option<CargoWorkspace>,
43 /// Holds cfg flags for the current target. We get those by running
44 /// `rustc --print cfg`.
46 /// FIXME: make this a per-crate map, as, eg, build.rs might have a
48 rustc_cfg: Vec<CfgFlag>,
50 /// Project workspace was manually specified using a `rust-project.json` file.
51 Json { project: ProjectJson, sysroot: Option<Sysroot>, rustc_cfg: Vec<CfgFlag> },
54 impl fmt::Debug for ProjectWorkspace {
55 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
56 // Make sure this isn't too verbose.
58 ProjectWorkspace::Cargo { cargo, sysroot, rustc, rustc_cfg } => f
59 .debug_struct("Cargo")
60 .field("root", &cargo.workspace_root().file_name())
61 .field("n_packages", &cargo.packages().len())
62 .field("n_sysroot_crates", &sysroot.crates().len())
64 "n_rustc_compiler_crates",
65 &rustc.as_ref().map_or(0, |rc| rc.packages().len()),
67 .field("n_rustc_cfg", &rustc_cfg.len())
69 ProjectWorkspace::Json { project, sysroot, rustc_cfg } => {
70 let mut debug_struct = f.debug_struct("Json");
71 debug_struct.field("n_crates", &project.n_crates());
72 if let Some(sysroot) = sysroot {
73 debug_struct.field("n_sysroot_crates", &sysroot.crates().len());
75 debug_struct.field("n_rustc_cfg", &rustc_cfg.len());
82 impl ProjectWorkspace {
84 manifest: ProjectManifest,
86 progress: &dyn Fn(String),
87 ) -> Result<ProjectWorkspace> {
88 let res = match manifest {
89 ProjectManifest::ProjectJson(project_json) => {
90 let file = fs::read_to_string(&project_json).with_context(|| {
91 format!("Failed to read json file {}", project_json.display())
93 let data = serde_json::from_str(&file).with_context(|| {
94 format!("Failed to deserialize json file {}", project_json.display())
96 let project_location = project_json.parent().unwrap().to_path_buf();
97 let project_json = ProjectJson::new(&project_location, data);
98 ProjectWorkspace::load_inline(project_json, config.target.as_deref())?
100 ProjectManifest::CargoToml(cargo_toml) => {
101 let cargo_version = utf8_stdout({
102 let mut cmd = Command::new(toolchain::cargo());
103 cmd.arg("--version");
107 let cargo = CargoWorkspace::from_cargo_metadata(&cargo_toml, config, progress)
110 "Failed to read Cargo metadata from Cargo.toml file {}, {}",
111 cargo_toml.display(),
116 let sysroot = if config.no_sysroot {
119 Sysroot::discover(&cargo_toml).with_context(|| {
121 "Failed to find sysroot for Cargo.toml file {}. Is rust-src installed?",
127 let rustc_dir = if let Some(rustc_source) = &config.rustc_source {
128 use cargo_workspace::RustcSource;
130 RustcSource::Path(path) => Some(path.clone()),
131 RustcSource::Discover => Sysroot::discover_rustc(&cargo_toml),
137 let rustc = if let Some(rustc_dir) = rustc_dir {
139 CargoWorkspace::from_cargo_metadata(&rustc_dir, config, progress)
141 format!("Failed to read Cargo metadata for Rust sources")
148 let rustc_cfg = rustc_cfg::get(Some(&cargo_toml), config.target.as_deref());
149 ProjectWorkspace::Cargo { cargo, sysroot, rustc, rustc_cfg }
151 ProjectManifest::DetachedFile(_) => {
160 project_json: ProjectJson,
161 target: Option<&str>,
162 ) -> Result<ProjectWorkspace> {
163 let sysroot = match &project_json.sysroot_src {
164 Some(path) => Some(Sysroot::load(path)?),
167 let rustc_cfg = rustc_cfg::get(None, target);
168 Ok(ProjectWorkspace::Json { project: project_json, sysroot, rustc_cfg })
171 /// Returns the roots for the current `ProjectWorkspace`
172 /// The return type contains the path and whether or not
173 /// the root is a member of the current workspace
174 pub fn to_roots(&self, build_data: Option<&BuildDataResult>) -> Vec<PackageRoot> {
176 ProjectWorkspace::Json { project, sysroot, rustc_cfg: _ } => project
178 .map(|(_, krate)| PackageRoot {
179 is_member: krate.is_workspace_member,
180 include: krate.include.clone(),
181 exclude: krate.exclude.clone(),
183 .collect::<FxHashSet<_>>()
185 .chain(sysroot.as_ref().into_iter().flat_map(|sysroot| {
186 sysroot.crates().map(move |krate| PackageRoot {
188 include: vec![sysroot[krate].root_dir().to_path_buf()],
192 .collect::<Vec<_>>(),
193 ProjectWorkspace::Cargo { cargo, sysroot, rustc, rustc_cfg: _ } => cargo
196 let is_member = cargo[pkg].is_member;
197 let pkg_root = cargo[pkg].root().to_path_buf();
199 let mut include = vec![pkg_root.clone()];
202 .and_then(|it| it.get(cargo.workspace_root()))
203 .and_then(|map| map.get(&cargo[pkg].id))
204 .and_then(|it| it.out_dir.clone()),
207 let mut exclude = vec![pkg_root.join(".git")];
209 exclude.push(pkg_root.join("target"));
211 exclude.push(pkg_root.join("tests"));
212 exclude.push(pkg_root.join("examples"));
213 exclude.push(pkg_root.join("benches"));
215 PackageRoot { is_member, include, exclude }
217 .chain(sysroot.crates().map(|krate| PackageRoot {
219 include: vec![sysroot[krate].root_dir().to_path_buf()],
222 .chain(rustc.into_iter().flat_map(|rustc| {
223 rustc.packages().map(move |krate| PackageRoot {
225 include: vec![rustc[krate].root().to_path_buf()],
233 pub fn n_packages(&self) -> usize {
235 ProjectWorkspace::Json { project, .. } => project.n_crates(),
236 ProjectWorkspace::Cargo { cargo, sysroot, rustc, .. } => {
237 let rustc_package_len = rustc.as_ref().map_or(0, |rc| rc.packages().len());
238 cargo.packages().len() + sysroot.crates().len() + rustc_package_len
243 pub fn to_crate_graph(
245 build_data: Option<&BuildDataResult>,
246 proc_macro_client: Option<&ProcMacroClient>,
247 load: &mut dyn FnMut(&AbsPath) -> Option<FileId>,
249 let _p = profile::span("ProjectWorkspace::to_crate_graph");
250 let proc_macro_loader = |path: &Path| match proc_macro_client {
251 Some(client) => client.by_dylib_path(path),
255 let mut crate_graph = match self {
256 ProjectWorkspace::Json { project, sysroot, rustc_cfg } => project_json_to_crate_graph(
263 ProjectWorkspace::Cargo { cargo, sysroot, rustc, rustc_cfg } => cargo_to_crate_graph(
268 build_data.and_then(|it| it.get(cargo.workspace_root())),
271 rustc.as_ref().zip(build_data).and_then(|(it, map)| map.get(it.workspace_root())),
274 if crate_graph.patch_cfg_if() {
275 log::debug!("Patched std to depend on cfg-if")
277 log::debug!("Did not patch std to depend on cfg-if")
282 pub fn collect_build_data_configs(&self, collector: &mut BuildDataCollector) {
284 ProjectWorkspace::Cargo { cargo, .. } => {
285 collector.add_config(&cargo.workspace_root(), cargo.build_data_config().clone());
292 fn project_json_to_crate_graph(
293 rustc_cfg: Vec<CfgFlag>,
294 proc_macro_loader: &dyn Fn(&Path) -> Vec<ProcMacro>,
295 load: &mut dyn FnMut(&AbsPath) -> Option<FileId>,
296 project: &ProjectJson,
297 sysroot: &Option<Sysroot>,
299 let mut crate_graph = CrateGraph::default();
300 let sysroot_deps = sysroot
302 .map(|sysroot| sysroot_to_crate_graph(&mut crate_graph, sysroot, rustc_cfg.clone(), load));
304 let mut cfg_cache: FxHashMap<&str, Vec<CfgFlag>> = FxHashMap::default();
305 let crates: FxHashMap<CrateId, CrateId> = project
307 .filter_map(|(crate_id, krate)| {
308 let file_path = &krate.root_module;
309 let file_id = load(&file_path)?;
310 Some((crate_id, krate, file_id))
312 .map(|(crate_id, krate, file_id)| {
313 let env = krate.env.clone().into_iter().collect();
314 let proc_macro = krate.proc_macro_dylib_path.clone().map(|it| proc_macro_loader(&it));
316 let target_cfgs = match krate.target.as_deref() {
318 cfg_cache.entry(target).or_insert_with(|| rustc_cfg::get(None, Some(target)))
323 let mut cfg_options = CfgOptions::default();
324 cfg_options.extend(target_cfgs.iter().chain(krate.cfg.iter()).cloned());
327 crate_graph.add_crate_root(
330 krate.display_name.clone(),
333 proc_macro.unwrap_or_default(),
339 for (from, krate) in project.crates() {
340 if let Some(&from) = crates.get(&from) {
341 if let Some((public_deps, _proc_macro)) = &sysroot_deps {
342 for (name, to) in public_deps.iter() {
343 add_dep(&mut crate_graph, from, name.clone(), *to)
347 for dep in &krate.deps {
348 if let Some(&to) = crates.get(&dep.crate_id) {
349 add_dep(&mut crate_graph, from, dep.name.clone(), to)
357 fn cargo_to_crate_graph(
358 rustc_cfg: Vec<CfgFlag>,
359 proc_macro_loader: &dyn Fn(&Path) -> Vec<ProcMacro>,
360 load: &mut dyn FnMut(&AbsPath) -> Option<FileId>,
361 cargo: &CargoWorkspace,
362 build_data_map: Option<&WorkspaceBuildData>,
364 rustc: &Option<CargoWorkspace>,
365 rustc_build_data_map: Option<&WorkspaceBuildData>,
367 let _p = profile::span("cargo_to_crate_graph");
368 let mut crate_graph = CrateGraph::default();
369 let (public_deps, libproc_macro) =
370 sysroot_to_crate_graph(&mut crate_graph, sysroot, rustc_cfg.clone(), load);
372 let mut cfg_options = CfgOptions::default();
373 cfg_options.extend(rustc_cfg);
375 let mut pkg_to_lib_crate = FxHashMap::default();
377 // Add test cfg for non-sysroot crates
378 cfg_options.insert_atom("test".into());
379 cfg_options.insert_atom("debug_assertions".into());
381 let mut pkg_crates = FxHashMap::default();
382 // Does any crate signal to rust-analyzer that they need the rustc_private crates?
383 let mut has_private = false;
384 // Next, create crates for each package, target pair
385 for pkg in cargo.packages() {
386 has_private |= cargo[pkg].metadata.rustc_private;
387 let mut lib_tgt = None;
388 for &tgt in cargo[pkg].targets.iter() {
389 if let Some(file_id) = load(&cargo[tgt].root) {
390 let crate_id = add_target_crate_root(
393 build_data_map.and_then(|it| it.get(&cargo[pkg].id)),
399 if cargo[tgt].kind == TargetKind::Lib {
400 lib_tgt = Some((crate_id, cargo[tgt].name.clone()));
401 pkg_to_lib_crate.insert(pkg, crate_id);
403 if cargo[tgt].is_proc_macro {
404 if let Some(proc_macro) = libproc_macro {
408 CrateName::new("proc_macro").unwrap(),
414 pkg_crates.entry(pkg).or_insert_with(Vec::new).push((crate_id, cargo[tgt].kind));
418 // Set deps to the core, std and to the lib target of the current package
419 for (from, kind) in pkg_crates.get(&pkg).into_iter().flatten() {
420 if let Some((to, name)) = lib_tgt.clone() {
421 if to != *from && *kind != TargetKind::BuildScript {
422 // (build script can not depend on its library target)
424 // For root projects with dashes in their name,
425 // cargo metadata does not do any normalization,
426 // so we do it ourselves currently
427 let name = CrateName::normalize_dashes(&name);
428 add_dep(&mut crate_graph, *from, name, to);
431 for (name, krate) in public_deps.iter() {
432 add_dep(&mut crate_graph, *from, name.clone(), *krate);
437 // Now add a dep edge from all targets of upstream to the lib
438 // target of downstream.
439 for pkg in cargo.packages() {
440 for dep in cargo[pkg].dependencies.iter() {
441 let name = CrateName::new(&dep.name).unwrap();
442 if let Some(&to) = pkg_to_lib_crate.get(&dep.pkg) {
443 for (from, kind) in pkg_crates.get(&pkg).into_iter().flatten() {
444 if dep.kind == DepKind::Build && *kind != TargetKind::BuildScript {
445 // Only build scripts may depend on build dependencies.
448 if dep.kind != DepKind::Build && *kind == TargetKind::BuildScript {
449 // Build scripts may only depend on build dependencies.
453 add_dep(&mut crate_graph, *from, name.clone(), to)
460 // If the user provided a path to rustc sources, we add all the rustc_private crates
461 // and create dependencies on them for the crates which opt-in to that
462 if let Some(rustc_workspace) = rustc {
467 rustc_build_data_map,
470 &mut pkg_to_lib_crate,
480 fn handle_rustc_crates(
481 rustc_workspace: &CargoWorkspace,
482 load: &mut dyn FnMut(&AbsPath) -> Option<FileId>,
483 crate_graph: &mut CrateGraph,
484 rustc_build_data_map: Option<&WorkspaceBuildData>,
485 cfg_options: &CfgOptions,
486 proc_macro_loader: &dyn Fn(&Path) -> Vec<ProcMacro>,
487 pkg_to_lib_crate: &mut FxHashMap<la_arena::Idx<crate::PackageData>, CrateId>,
488 public_deps: &[(CrateName, CrateId)],
489 cargo: &CargoWorkspace,
490 pkg_crates: &FxHashMap<la_arena::Idx<crate::PackageData>, Vec<(CrateId, TargetKind)>>,
492 let mut rustc_pkg_crates = FxHashMap::default();
493 // The root package of the rustc-dev component is rustc_driver, so we match that
495 rustc_workspace.packages().find(|package| rustc_workspace[*package].name == "rustc_driver");
496 // The rustc workspace might be incomplete (such as if rustc-dev is not
497 // installed for the current toolchain) and `rustcSource` is set to discover.
498 if let Some(root_pkg) = root_pkg {
499 // Iterate through every crate in the dependency subtree of rustc_driver using BFS
500 let mut queue = VecDeque::new();
501 queue.push_back(root_pkg);
502 while let Some(pkg) = queue.pop_front() {
503 // Don't duplicate packages if they are dependended on a diamond pattern
504 // N.B. if this line is ommitted, we try to analyse over 4_800_000 crates
505 // which is not ideal
506 if rustc_pkg_crates.contains_key(&pkg) {
509 for dep in &rustc_workspace[pkg].dependencies {
510 queue.push_back(dep.pkg);
512 for &tgt in rustc_workspace[pkg].targets.iter() {
513 if rustc_workspace[tgt].kind != TargetKind::Lib {
516 if let Some(file_id) = load(&rustc_workspace[tgt].root) {
517 let crate_id = add_target_crate_root(
519 &rustc_workspace[pkg],
520 rustc_build_data_map.and_then(|it| it.get(&rustc_workspace[pkg].id)),
524 &rustc_workspace[tgt].name,
526 pkg_to_lib_crate.insert(pkg, crate_id);
527 // Add dependencies on core / std / alloc for this crate
528 for (name, krate) in public_deps.iter() {
529 add_dep(crate_graph, crate_id, name.clone(), *krate);
531 rustc_pkg_crates.entry(pkg).or_insert_with(Vec::new).push(crate_id);
536 // Now add a dep edge from all targets of upstream to the lib
537 // target of downstream.
538 for pkg in rustc_pkg_crates.keys().copied() {
539 for dep in rustc_workspace[pkg].dependencies.iter() {
540 let name = CrateName::new(&dep.name).unwrap();
541 if let Some(&to) = pkg_to_lib_crate.get(&dep.pkg) {
542 for &from in rustc_pkg_crates.get(&pkg).into_iter().flatten() {
543 add_dep(crate_graph, from, name.clone(), to);
548 // Add a dependency on the rustc_private crates for all targets of each package
550 for dep in rustc_workspace.packages() {
551 let name = CrateName::normalize_dashes(&rustc_workspace[dep].name);
553 if let Some(&to) = pkg_to_lib_crate.get(&dep) {
554 for pkg in cargo.packages() {
555 let package = &cargo[pkg];
556 if !package.metadata.rustc_private {
559 for (from, _) in pkg_crates.get(&pkg).into_iter().flatten() {
560 // Avoid creating duplicate dependencies
561 // This avoids the situation where `from` depends on e.g. `arrayvec`, but
562 // `rust_analyzer` thinks that it should use the one from the `rustcSource`
563 // instead of the one from `crates.io`
564 if !crate_graph[*from].dependencies.iter().any(|d| d.name == name) {
565 add_dep(crate_graph, *from, name.clone(), to);
573 fn add_target_crate_root(
574 crate_graph: &mut CrateGraph,
575 pkg: &cargo_workspace::PackageData,
576 build_data: Option<&PackageBuildData>,
577 cfg_options: &CfgOptions,
578 proc_macro_loader: &dyn Fn(&Path) -> Vec<ProcMacro>,
582 let edition = pkg.edition;
584 let mut opts = cfg_options.clone();
585 for feature in pkg.active_features.iter() {
586 opts.insert_key_value("feature".into(), feature.into());
588 if let Some(cfgs) = build_data.as_ref().map(|it| &it.cfgs) {
589 opts.extend(cfgs.iter().cloned());
594 let mut env = Env::default();
595 if let Some(envs) = build_data.map(|it| &it.envs) {
597 env.set(k, v.clone());
601 let proc_macro = build_data
603 .and_then(|it| it.proc_macro_dylib_path.as_ref())
604 .map(|it| proc_macro_loader(&it))
605 .unwrap_or_default();
607 let display_name = CrateDisplayName::from_canonical_name(cargo_name.to_string());
608 let crate_id = crate_graph.add_crate_root(
620 fn sysroot_to_crate_graph(
621 crate_graph: &mut CrateGraph,
623 rustc_cfg: Vec<CfgFlag>,
624 load: &mut dyn FnMut(&AbsPath) -> Option<FileId>,
625 ) -> (Vec<(CrateName, CrateId)>, Option<CrateId>) {
626 let _p = profile::span("sysroot_to_crate_graph");
627 let mut cfg_options = CfgOptions::default();
628 cfg_options.extend(rustc_cfg);
629 let sysroot_crates: FxHashMap<SysrootCrate, CrateId> = sysroot
631 .filter_map(|krate| {
632 let file_id = load(&sysroot[krate].root)?;
634 let env = Env::default();
635 let proc_macro = vec![];
636 let display_name = CrateDisplayName::from_canonical_name(sysroot[krate].name.clone());
637 let crate_id = crate_graph.add_crate_root(
639 Edition::Edition2018,
645 Some((krate, crate_id))
649 for from in sysroot.crates() {
650 for &to in sysroot[from].deps.iter() {
651 let name = CrateName::new(&sysroot[to].name).unwrap();
652 if let (Some(&from), Some(&to)) = (sysroot_crates.get(&from), sysroot_crates.get(&to)) {
653 add_dep(crate_graph, from, name, to);
658 let public_deps = sysroot
660 .map(|(name, idx)| (CrateName::new(name).unwrap(), sysroot_crates[&idx]))
661 .collect::<Vec<_>>();
663 let libproc_macro = sysroot.proc_macro().and_then(|it| sysroot_crates.get(&it).copied());
664 (public_deps, libproc_macro)
667 fn add_dep(graph: &mut CrateGraph, from: CrateId, name: CrateName, to: CrateId) {
668 if let Err(err) = graph.add_dep(from, name, to) {
669 log::error!("{}", err)