1 //! FIXME: write short doc here
8 fs::{read_dir, File, ReadDir},
10 path::{Path, PathBuf},
11 process::{Command, Output},
14 use anyhow::{bail, Context, Result};
15 use ra_cfg::CfgOptions;
16 use ra_db::{CrateGraph, CrateName, Edition, Env, ExternSource, ExternSourceId, FileId};
17 use rustc_hash::{FxHashMap, FxHashSet};
18 use serde_json::from_reader;
21 cargo_workspace::{CargoConfig, CargoWorkspace, Package, Target, TargetKind},
22 json_project::JsonProject,
25 pub use ra_proc_macro::ProcMacroClient;
27 #[derive(Debug, Clone)]
28 pub enum ProjectWorkspace {
29 /// Project workspace was discovered by running `cargo metadata` and `rustc --print sysroot`.
30 Cargo { cargo: CargoWorkspace, sysroot: Sysroot },
31 /// Project workspace was manually specified using a `rust-project.json` file.
32 Json { project: JsonProject },
35 impl From<JsonProject> for ProjectWorkspace {
36 fn from(project: JsonProject) -> ProjectWorkspace {
37 ProjectWorkspace::Json { project }
41 /// `PackageRoot` describes a package root folder.
42 /// Which may be an external dependency, or a member of
43 /// the current workspace.
44 #[derive(Debug, Clone)]
45 pub struct PackageRoot {
46 /// Path to the root folder
48 /// Is a member of the current workspace
52 pub fn new_member(path: PathBuf) -> PackageRoot {
53 Self { path, is_member: true }
55 pub fn new_non_member(path: PathBuf) -> PackageRoot {
56 Self { path, is_member: false }
58 pub fn path(&self) -> &Path {
61 pub fn is_member(&self) -> bool {
66 #[derive(Debug, Clone, PartialEq, Eq, Hash, Ord, PartialOrd)]
67 pub enum ProjectManifest {
72 impl ProjectManifest {
73 pub fn from_manifest_file(path: PathBuf) -> Result<ProjectManifest> {
74 if path.ends_with("rust-project.json") {
75 return Ok(ProjectManifest::ProjectJson(path));
77 if path.ends_with("Cargo.toml") {
78 return Ok(ProjectManifest::CargoToml(path));
80 bail!("project root must point to Cargo.toml or rust-project.json: {}", path.display())
83 pub fn discover_single(path: &Path) -> Result<ProjectManifest> {
84 let mut candidates = ProjectManifest::discover(path)?;
85 let res = match candidates.pop() {
86 None => bail!("no projects"),
90 if !candidates.is_empty() {
91 bail!("more than one project")
96 pub fn discover(path: &Path) -> io::Result<Vec<ProjectManifest>> {
97 if let Some(project_json) = find_in_parent_dirs(path, "rust-project.json") {
98 return Ok(vec![ProjectManifest::ProjectJson(project_json)]);
100 return find_cargo_toml(path)
101 .map(|paths| paths.into_iter().map(ProjectManifest::CargoToml).collect());
103 fn find_cargo_toml(path: &Path) -> io::Result<Vec<PathBuf>> {
104 match find_in_parent_dirs(path, "Cargo.toml") {
105 Some(it) => Ok(vec![it]),
106 None => Ok(find_cargo_toml_in_child_dir(read_dir(path)?)),
110 fn find_in_parent_dirs(path: &Path, target_file_name: &str) -> Option<PathBuf> {
111 if path.ends_with(target_file_name) {
112 return Some(path.to_owned());
115 let mut curr = Some(path);
117 while let Some(path) = curr {
118 let candidate = path.join(target_file_name);
119 if candidate.exists() {
120 return Some(candidate);
122 curr = path.parent();
128 fn find_cargo_toml_in_child_dir(entities: ReadDir) -> Vec<PathBuf> {
129 // Only one level down to avoid cycles the easy way and stop a runaway scan with large projects
131 .filter_map(Result::ok)
132 .map(|it| it.path().join("Cargo.toml"))
133 .filter(|it| it.exists())
138 pub fn discover_all(paths: &[impl AsRef<Path>]) -> Vec<ProjectManifest> {
141 .filter_map(|it| ProjectManifest::discover(it.as_ref()).ok())
143 .collect::<FxHashSet<_>>()
145 .collect::<Vec<_>>();
151 impl ProjectWorkspace {
153 manifest: ProjectManifest,
154 cargo_features: &CargoConfig,
156 ) -> Result<ProjectWorkspace> {
157 let res = match manifest {
158 ProjectManifest::ProjectJson(project_json) => {
159 let file = File::open(&project_json).with_context(|| {
160 format!("Failed to open json file {}", project_json.display())
162 let reader = BufReader::new(file);
163 ProjectWorkspace::Json {
164 project: from_reader(reader).with_context(|| {
165 format!("Failed to deserialize json file {}", project_json.display())
169 ProjectManifest::CargoToml(cargo_toml) => {
170 let cargo = CargoWorkspace::from_cargo_metadata(&cargo_toml, cargo_features)
173 "Failed to read Cargo metadata from Cargo.toml file {}",
177 let sysroot = if with_sysroot {
178 Sysroot::discover(&cargo_toml).with_context(|| {
180 "Failed to find sysroot for Cargo.toml file {}. Is rust-src installed?",
187 ProjectWorkspace::Cargo { cargo, sysroot }
194 /// Returns the roots for the current `ProjectWorkspace`
195 /// The return type contains the path and whether or not
196 /// the root is a member of the current workspace
197 pub fn to_roots(&self) -> Vec<PackageRoot> {
199 ProjectWorkspace::Json { project } => {
200 project.roots.iter().map(|r| PackageRoot::new_member(r.path.clone())).collect()
202 ProjectWorkspace::Cargo { cargo, sysroot } => cargo
204 .map(|pkg| PackageRoot {
205 path: cargo[pkg].root().to_path_buf(),
206 is_member: cargo[pkg].is_member,
208 .chain(sysroot.crates().map(|krate| {
209 PackageRoot::new_non_member(sysroot[krate].root_dir().to_path_buf())
215 pub fn out_dirs(&self) -> Vec<PathBuf> {
217 ProjectWorkspace::Json { project } => {
218 project.crates.iter().filter_map(|krate| krate.out_dir.as_ref()).cloned().collect()
220 ProjectWorkspace::Cargo { cargo, sysroot: _ } => {
221 cargo.packages().filter_map(|pkg| cargo[pkg].out_dir.as_ref()).cloned().collect()
226 pub fn proc_macro_dylib_paths(&self) -> Vec<PathBuf> {
228 ProjectWorkspace::Json { project } => project
231 .filter_map(|krate| krate.proc_macro_dylib_path.as_ref())
234 ProjectWorkspace::Cargo { cargo, sysroot: _sysroot } => cargo
236 .filter_map(|pkg| cargo[pkg].proc_macro_dylib_path.as_ref())
242 pub fn n_packages(&self) -> usize {
244 ProjectWorkspace::Json { project } => project.crates.len(),
245 ProjectWorkspace::Cargo { cargo, sysroot } => {
246 cargo.packages().len() + sysroot.crates().len()
251 pub fn to_crate_graph(
253 default_cfg_options: &CfgOptions,
254 extern_source_roots: &FxHashMap<PathBuf, ExternSourceId>,
255 proc_macro_client: &ProcMacroClient,
256 load: &mut dyn FnMut(&Path) -> Option<FileId>,
258 let mut crate_graph = CrateGraph::default();
260 ProjectWorkspace::Json { project } => {
261 let crates: FxHashMap<_, _> = project
265 .filter_map(|(seq_index, krate)| {
266 let file_id = load(&krate.root_module)?;
267 let edition = match krate.edition {
268 json_project::Edition::Edition2015 => Edition::Edition2015,
269 json_project::Edition::Edition2018 => Edition::Edition2018,
272 let mut opts = default_cfg_options.clone();
273 for cfg in &krate.cfg {
274 match cfg.find('=') {
275 None => opts.insert_atom(cfg.into()),
277 let key = &cfg[..pos];
278 let value = cfg[pos + 1..].trim_matches('"');
279 opts.insert_key_value(key.into(), value.into());
283 for name in &krate.atom_cfgs {
284 opts.insert_atom(name.into());
286 for (key, value) in &krate.key_value_cfgs {
287 opts.insert_key_value(key.into(), value.into());
292 let mut env = Env::default();
293 let mut extern_source = ExternSource::default();
294 if let Some(out_dir) = &krate.out_dir {
295 // NOTE: cargo and rustc seem to hide non-UTF-8 strings from env! and option_env!()
296 if let Some(out_dir) = out_dir.to_str().map(|s| s.to_owned()) {
297 env.set("OUT_DIR", out_dir);
299 if let Some(&extern_source_id) = extern_source_roots.get(out_dir) {
300 extern_source.set_extern_path(&out_dir, extern_source_id);
303 let proc_macro = krate
304 .proc_macro_dylib_path
306 .map(|it| proc_macro_client.by_dylib_path(&it));
307 // FIXME: No crate name in json definition such that we cannot add OUT_DIR to env
309 json_project::CrateId(seq_index),
310 crate_graph.add_crate_root(
313 // FIXME json definitions can store the crate name
318 proc_macro.unwrap_or_default(),
324 for (id, krate) in project.crates.iter().enumerate() {
325 for dep in &krate.deps {
326 let from_crate_id = json_project::CrateId(id);
327 let to_crate_id = dep.krate;
328 if let (Some(&from), Some(&to)) =
329 (crates.get(&from_crate_id), crates.get(&to_crate_id))
332 .add_dep(from, CrateName::new(&dep.name).unwrap(), to)
336 "cyclic dependency {:?} -> {:?}",
345 ProjectWorkspace::Cargo { cargo, sysroot } => {
346 let sysroot_crates: FxHashMap<_, _> = sysroot
348 .filter_map(|krate| {
349 let file_id = load(&sysroot[krate].root)?;
351 // Crates from sysroot have `cfg(test)` disabled
353 let mut opts = default_cfg_options.clone();
354 opts.remove_atom("test");
358 let env = Env::default();
359 let extern_source = ExternSource::default();
360 let proc_macro = vec![];
361 let crate_name = CrateName::new(&sysroot[krate].name)
362 .expect("Sysroot crate names should not contain dashes");
364 let crate_id = crate_graph.add_crate_root(
366 Edition::Edition2018,
373 Some((krate, crate_id))
377 for from in sysroot.crates() {
378 for &to in sysroot[from].deps.iter() {
379 let name = &sysroot[to].name;
380 if let (Some(&from), Some(&to)) =
381 (sysroot_crates.get(&from), sysroot_crates.get(&to))
383 if crate_graph.add_dep(from, CrateName::new(name).unwrap(), to).is_err()
385 log::error!("cyclic dependency between sysroot crates")
391 let libcore = sysroot.core().and_then(|it| sysroot_crates.get(&it).copied());
392 let liballoc = sysroot.alloc().and_then(|it| sysroot_crates.get(&it).copied());
393 let libstd = sysroot.std().and_then(|it| sysroot_crates.get(&it).copied());
395 sysroot.proc_macro().and_then(|it| sysroot_crates.get(&it).copied());
397 let mut pkg_to_lib_crate = FxHashMap::default();
398 let mut pkg_crates = FxHashMap::default();
399 // Next, create crates for each package, target pair
400 for pkg in cargo.packages() {
401 let mut lib_tgt = None;
402 for &tgt in cargo[pkg].targets.iter() {
403 let root = cargo[tgt].root.as_path();
404 if let Some(file_id) = load(root) {
405 let edition = cargo[pkg].edition;
407 let mut opts = default_cfg_options.clone();
408 for feature in cargo[pkg].features.iter() {
409 opts.insert_key_value("feature".into(), feature.into());
411 for cfg in cargo[pkg].cfgs.iter() {
412 match cfg.find('=') {
413 Some(split) => opts.insert_key_value(
415 cfg[split + 1..].trim_matches('"').into(),
417 None => opts.insert_atom(cfg.into()),
422 let mut env = Env::default();
423 let mut extern_source = ExternSource::default();
424 if let Some(out_dir) = &cargo[pkg].out_dir {
425 // NOTE: cargo and rustc seem to hide non-UTF-8 strings from env! and option_env!()
426 if let Some(out_dir) = out_dir.to_str().map(|s| s.to_owned()) {
427 env.set("OUT_DIR", out_dir);
429 if let Some(&extern_source_id) = extern_source_roots.get(out_dir) {
430 extern_source.set_extern_path(&out_dir, extern_source_id);
433 let proc_macro = cargo[pkg]
434 .proc_macro_dylib_path
436 .map(|it| proc_macro_client.by_dylib_path(&it))
437 .unwrap_or_default();
439 let crate_id = crate_graph.add_crate_root(
442 Some(CrateName::normalize_dashes(&cargo[pkg].name)),
448 if cargo[tgt].kind == TargetKind::Lib {
449 lib_tgt = Some((crate_id, cargo[tgt].name.clone()));
450 pkg_to_lib_crate.insert(pkg, crate_id);
452 if cargo[tgt].is_proc_macro {
453 if let Some(proc_macro) = libproc_macro {
457 CrateName::new("proc_macro").unwrap(),
463 "cyclic dependency on proc_macro for {}",
470 pkg_crates.entry(pkg).or_insert_with(Vec::new).push(crate_id);
474 // Set deps to the core, std and to the lib target of the current package
475 for &from in pkg_crates.get(&pkg).into_iter().flatten() {
476 if let Some((to, name)) = lib_tgt.clone() {
481 // For root projects with dashes in their name,
482 // cargo metadata does not do any normalization,
483 // so we do it ourselves currently
484 CrateName::normalize_dashes(&name),
491 "cyclic dependency between targets of {}",
497 // core is added as a dependency before std in order to
498 // mimic rustcs dependency order
499 if let Some(core) = libcore {
501 .add_dep(from, CrateName::new("core").unwrap(), core)
504 log::error!("cyclic dependency on core for {}", &cargo[pkg].name)
507 if let Some(alloc) = liballoc {
509 .add_dep(from, CrateName::new("alloc").unwrap(), alloc)
512 log::error!("cyclic dependency on alloc for {}", &cargo[pkg].name)
515 if let Some(std) = libstd {
517 .add_dep(from, CrateName::new("std").unwrap(), std)
520 log::error!("cyclic dependency on std for {}", &cargo[pkg].name)
526 // Now add a dep edge from all targets of upstream to the lib
527 // target of downstream.
528 for pkg in cargo.packages() {
529 for dep in cargo[pkg].dependencies.iter() {
530 if let Some(&to) = pkg_to_lib_crate.get(&dep.pkg) {
531 for &from in pkg_crates.get(&pkg).into_iter().flatten() {
533 .add_dep(from, CrateName::new(&dep.name).unwrap(), to)
537 "cyclic dependency {} -> {}",
551 pub fn workspace_root_for(&self, path: &Path) -> Option<&Path> {
553 ProjectWorkspace::Cargo { cargo, .. } => {
554 Some(cargo.workspace_root()).filter(|root| path.starts_with(root))
556 ProjectWorkspace::Json { project: JsonProject { roots, .. } } => roots
558 .find(|root| path.starts_with(&root.path))
559 .map(|root| root.path.as_ref()),
564 pub fn get_rustc_cfg_options(target: Option<&String>) -> CfgOptions {
565 let mut cfg_options = CfgOptions::default();
567 // Some nightly-only cfgs, which are required for stdlib
569 cfg_options.insert_atom("target_thread_local".into());
570 for &target_has_atomic in ["8", "16", "32", "64", "cas", "ptr"].iter() {
571 cfg_options.insert_key_value("target_has_atomic".into(), target_has_atomic.into());
573 .insert_key_value("target_has_atomic_load_store".into(), target_has_atomic.into());
577 let rustc_cfgs = || -> Result<String> {
578 // `cfg(test)` and `cfg(debug_assertion)` are handled outside, so we suppress them here.
579 let mut cmd = Command::new(ra_toolchain::rustc());
580 cmd.args(&["--print", "cfg", "-O"]);
581 if let Some(target) = target {
582 cmd.args(&["--target", target.as_str()]);
584 let output = output(cmd)?;
585 Ok(String::from_utf8(output.stdout)?)
590 for line in rustc_cfgs.lines() {
591 match line.find('=') {
592 None => cfg_options.insert_atom(line.into()),
594 let key = &line[..pos];
595 let value = line[pos + 1..].trim_matches('"');
596 cfg_options.insert_key_value(key.into(), value.into());
601 Err(e) => log::error!("failed to get rustc cfgs: {:#}", e),
607 fn output(mut cmd: Command) -> Result<Output> {
608 let output = cmd.output().with_context(|| format!("{:?} failed", cmd))?;
609 if !output.status.success() {
610 match String::from_utf8(output.stderr) {
611 Ok(stderr) if !stderr.is_empty() => {
612 bail!("{:?} failed, {}\nstderr:\n{}", cmd, output.status, stderr)
614 _ => bail!("{:?} failed, {}", cmd, output.status),