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;
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 /// `PackageRoot` describes a package root folder.
36 /// Which may be an external dependency, or a member of
37 /// the current workspace.
39 pub struct PackageRoot {
40 /// Path to the root folder
42 /// Is a member of the current workspace
46 pub fn new_member(path: PathBuf) -> PackageRoot {
47 Self { path, is_member: true }
49 pub fn new_non_member(path: PathBuf) -> PackageRoot {
50 Self { path, is_member: false }
52 pub fn path(&self) -> &Path {
55 pub fn is_member(&self) -> bool {
60 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
61 pub enum ProjectRoot {
67 pub fn from_manifest_file(path: PathBuf) -> Result<ProjectRoot> {
68 if path.ends_with("rust-project.json") {
69 return Ok(ProjectRoot::ProjectJson(path));
71 if path.ends_with("Cargo.toml") {
72 return Ok(ProjectRoot::CargoToml(path));
74 bail!("project root must point to Cargo.toml or rust-project.json: {}", path.display())
77 pub fn discover_single(path: &Path) -> Result<ProjectRoot> {
78 let mut candidates = ProjectRoot::discover(path)?;
79 let res = match candidates.pop() {
80 None => bail!("no projects"),
84 if !candidates.is_empty() {
85 bail!("more than one project")
90 pub fn discover(path: &Path) -> io::Result<Vec<ProjectRoot>> {
91 if let Some(project_json) = find_in_parent_dirs(path, "rust-project.json") {
92 return Ok(vec![ProjectRoot::ProjectJson(project_json)]);
94 return find_cargo_toml(path)
95 .map(|paths| paths.into_iter().map(ProjectRoot::CargoToml).collect());
97 fn find_cargo_toml(path: &Path) -> io::Result<Vec<PathBuf>> {
98 match find_in_parent_dirs(path, "Cargo.toml") {
99 Some(it) => Ok(vec![it]),
100 None => Ok(find_cargo_toml_in_child_dir(read_dir(path)?)),
104 fn find_in_parent_dirs(path: &Path, target_file_name: &str) -> Option<PathBuf> {
105 if path.ends_with(target_file_name) {
106 return Some(path.to_owned());
109 let mut curr = Some(path);
111 while let Some(path) = curr {
112 let candidate = path.join(target_file_name);
113 if candidate.exists() {
114 return Some(candidate);
116 curr = path.parent();
122 fn find_cargo_toml_in_child_dir(entities: ReadDir) -> Vec<PathBuf> {
123 // Only one level down to avoid cycles the easy way and stop a runaway scan with large projects
125 .filter_map(Result::ok)
126 .map(|it| it.path().join("Cargo.toml"))
127 .filter(|it| it.exists())
133 impl ProjectWorkspace {
136 cargo_features: &CargoConfig,
138 ) -> Result<ProjectWorkspace> {
139 let res = match root {
140 ProjectRoot::ProjectJson(project_json) => {
141 let file = File::open(&project_json).with_context(|| {
142 format!("Failed to open json file {}", project_json.display())
144 let reader = BufReader::new(file);
145 ProjectWorkspace::Json {
146 project: from_reader(reader).with_context(|| {
147 format!("Failed to deserialize json file {}", project_json.display())
151 ProjectRoot::CargoToml(cargo_toml) => {
152 let cargo = CargoWorkspace::from_cargo_metadata(&cargo_toml, cargo_features)
155 "Failed to read Cargo metadata from Cargo.toml file {}",
159 let sysroot = if with_sysroot {
160 Sysroot::discover(&cargo_toml).with_context(|| {
162 "Failed to find sysroot for Cargo.toml file {}. Is rust-src installed?",
169 ProjectWorkspace::Cargo { cargo, sysroot }
176 /// Returns the roots for the current `ProjectWorkspace`
177 /// The return type contains the path and whether or not
178 /// the root is a member of the current workspace
179 pub fn to_roots(&self) -> Vec<PackageRoot> {
181 ProjectWorkspace::Json { project } => {
182 project.roots.iter().map(|r| PackageRoot::new_member(r.path.clone())).collect()
184 ProjectWorkspace::Cargo { cargo, sysroot } => cargo
186 .map(|pkg| PackageRoot {
187 path: cargo[pkg].root().to_path_buf(),
188 is_member: cargo[pkg].is_member,
190 .chain(sysroot.crates().map(|krate| {
191 PackageRoot::new_non_member(sysroot[krate].root_dir().to_path_buf())
197 pub fn out_dirs(&self) -> Vec<PathBuf> {
199 ProjectWorkspace::Json { project } => {
200 project.crates.iter().filter_map(|krate| krate.out_dir.as_ref()).cloned().collect()
202 ProjectWorkspace::Cargo { cargo, sysroot: _ } => {
203 cargo.packages().filter_map(|pkg| cargo[pkg].out_dir.as_ref()).cloned().collect()
208 pub fn proc_macro_dylib_paths(&self) -> Vec<PathBuf> {
210 ProjectWorkspace::Json { project } => project
213 .filter_map(|krate| krate.proc_macro_dylib_path.as_ref())
216 ProjectWorkspace::Cargo { cargo, sysroot: _sysroot } => cargo
218 .filter_map(|pkg| cargo[pkg].proc_macro_dylib_path.as_ref())
224 pub fn n_packages(&self) -> usize {
226 ProjectWorkspace::Json { project } => project.crates.len(),
227 ProjectWorkspace::Cargo { cargo, sysroot } => {
228 cargo.packages().len() + sysroot.crates().len()
233 pub fn to_crate_graph(
235 default_cfg_options: &CfgOptions,
236 extern_source_roots: &FxHashMap<PathBuf, ExternSourceId>,
237 proc_macro_client: &ProcMacroClient,
238 load: &mut dyn FnMut(&Path) -> Option<FileId>,
240 let mut crate_graph = CrateGraph::default();
242 ProjectWorkspace::Json { project } => {
243 let crates: FxHashMap<_, _> = project
247 .filter_map(|(seq_index, krate)| {
248 let file_id = load(&krate.root_module)?;
249 let edition = match krate.edition {
250 json_project::Edition::Edition2015 => Edition::Edition2015,
251 json_project::Edition::Edition2018 => Edition::Edition2018,
254 let mut opts = default_cfg_options.clone();
255 for name in &krate.atom_cfgs {
256 opts.insert_atom(name.into());
258 for (key, value) in &krate.key_value_cfgs {
259 opts.insert_key_value(key.into(), value.into());
264 let mut env = Env::default();
265 let mut extern_source = ExternSource::default();
266 if let Some(out_dir) = &krate.out_dir {
267 // NOTE: cargo and rustc seem to hide non-UTF-8 strings from env! and option_env!()
268 if let Some(out_dir) = out_dir.to_str().map(|s| s.to_owned()) {
269 env.set("OUT_DIR", out_dir);
271 if let Some(&extern_source_id) = extern_source_roots.get(out_dir) {
272 extern_source.set_extern_path(&out_dir, extern_source_id);
275 let proc_macro = krate
276 .proc_macro_dylib_path
278 .map(|it| proc_macro_client.by_dylib_path(&it));
279 // FIXME: No crate name in json definition such that we cannot add OUT_DIR to env
281 json_project::CrateId(seq_index),
282 crate_graph.add_crate_root(
285 // FIXME json definitions can store the crate name
290 proc_macro.unwrap_or_default(),
296 for (id, krate) in project.crates.iter().enumerate() {
297 for dep in &krate.deps {
298 let from_crate_id = json_project::CrateId(id);
299 let to_crate_id = dep.krate;
300 if let (Some(&from), Some(&to)) =
301 (crates.get(&from_crate_id), crates.get(&to_crate_id))
304 .add_dep(from, CrateName::new(&dep.name).unwrap(), to)
308 "cyclic dependency {:?} -> {:?}",
317 ProjectWorkspace::Cargo { cargo, sysroot } => {
318 let sysroot_crates: FxHashMap<_, _> = sysroot
320 .filter_map(|krate| {
321 let file_id = load(&sysroot[krate].root)?;
323 // Crates from sysroot have `cfg(test)` disabled
325 let mut opts = default_cfg_options.clone();
326 opts.remove_atom("test");
330 let env = Env::default();
331 let extern_source = ExternSource::default();
332 let proc_macro = vec![];
333 let crate_name = CrateName::new(&sysroot[krate].name)
334 .expect("Sysroot crate names should not contain dashes");
336 let crate_id = crate_graph.add_crate_root(
338 Edition::Edition2018,
345 Some((krate, crate_id))
349 for from in sysroot.crates() {
350 for &to in sysroot[from].deps.iter() {
351 let name = &sysroot[to].name;
352 if let (Some(&from), Some(&to)) =
353 (sysroot_crates.get(&from), sysroot_crates.get(&to))
355 if crate_graph.add_dep(from, CrateName::new(name).unwrap(), to).is_err()
357 log::error!("cyclic dependency between sysroot crates")
363 let libcore = sysroot.core().and_then(|it| sysroot_crates.get(&it).copied());
364 let liballoc = sysroot.alloc().and_then(|it| sysroot_crates.get(&it).copied());
365 let libstd = sysroot.std().and_then(|it| sysroot_crates.get(&it).copied());
367 sysroot.proc_macro().and_then(|it| sysroot_crates.get(&it).copied());
369 let mut pkg_to_lib_crate = FxHashMap::default();
370 let mut pkg_crates = FxHashMap::default();
371 // Next, create crates for each package, target pair
372 for pkg in cargo.packages() {
373 let mut lib_tgt = None;
374 for &tgt in cargo[pkg].targets.iter() {
375 let root = cargo[tgt].root.as_path();
376 if let Some(file_id) = load(root) {
377 let edition = cargo[pkg].edition;
379 let mut opts = default_cfg_options.clone();
380 for feature in cargo[pkg].features.iter() {
381 opts.insert_key_value("feature".into(), feature.into());
383 for cfg in cargo[pkg].cfgs.iter() {
384 match cfg.find('=') {
385 Some(split) => opts.insert_key_value(
387 cfg[split + 1..].trim_matches('"').into(),
389 None => opts.insert_atom(cfg.into()),
394 let mut env = Env::default();
395 let mut extern_source = ExternSource::default();
396 if let Some(out_dir) = &cargo[pkg].out_dir {
397 // NOTE: cargo and rustc seem to hide non-UTF-8 strings from env! and option_env!()
398 if let Some(out_dir) = out_dir.to_str().map(|s| s.to_owned()) {
399 env.set("OUT_DIR", out_dir);
401 if let Some(&extern_source_id) = extern_source_roots.get(out_dir) {
402 extern_source.set_extern_path(&out_dir, extern_source_id);
405 let proc_macro = cargo[pkg]
406 .proc_macro_dylib_path
408 .map(|it| proc_macro_client.by_dylib_path(&it))
409 .unwrap_or_default();
411 let crate_id = crate_graph.add_crate_root(
414 Some(CrateName::normalize_dashes(&cargo[pkg].name)),
420 if cargo[tgt].kind == TargetKind::Lib {
421 lib_tgt = Some((crate_id, cargo[tgt].name.clone()));
422 pkg_to_lib_crate.insert(pkg, crate_id);
424 if cargo[tgt].is_proc_macro {
425 if let Some(proc_macro) = libproc_macro {
429 CrateName::new("proc_macro").unwrap(),
435 "cyclic dependency on proc_macro for {}",
442 pkg_crates.entry(pkg).or_insert_with(Vec::new).push(crate_id);
446 // Set deps to the core, std and to the lib target of the current package
447 for &from in pkg_crates.get(&pkg).into_iter().flatten() {
448 if let Some((to, name)) = lib_tgt.clone() {
453 // For root projects with dashes in their name,
454 // cargo metadata does not do any normalization,
455 // so we do it ourselves currently
456 CrateName::normalize_dashes(&name),
463 "cyclic dependency between targets of {}",
469 // core is added as a dependency before std in order to
470 // mimic rustcs dependency order
471 if let Some(core) = libcore {
473 .add_dep(from, CrateName::new("core").unwrap(), core)
476 log::error!("cyclic dependency on core for {}", &cargo[pkg].name)
479 if let Some(alloc) = liballoc {
481 .add_dep(from, CrateName::new("alloc").unwrap(), alloc)
484 log::error!("cyclic dependency on alloc for {}", &cargo[pkg].name)
487 if let Some(std) = libstd {
489 .add_dep(from, CrateName::new("std").unwrap(), std)
492 log::error!("cyclic dependency on std for {}", &cargo[pkg].name)
498 // Now add a dep edge from all targets of upstream to the lib
499 // target of downstream.
500 for pkg in cargo.packages() {
501 for dep in cargo[pkg].dependencies.iter() {
502 if let Some(&to) = pkg_to_lib_crate.get(&dep.pkg) {
503 for &from in pkg_crates.get(&pkg).into_iter().flatten() {
505 .add_dep(from, CrateName::new(&dep.name).unwrap(), to)
509 "cyclic dependency {} -> {}",
523 pub fn workspace_root_for(&self, path: &Path) -> Option<&Path> {
525 ProjectWorkspace::Cargo { cargo, .. } => {
526 Some(cargo.workspace_root()).filter(|root| path.starts_with(root))
528 ProjectWorkspace::Json { project: JsonProject { roots, .. } } => roots
530 .find(|root| path.starts_with(&root.path))
531 .map(|root| root.path.as_ref()),
536 pub fn get_rustc_cfg_options(target: Option<&String>) -> CfgOptions {
537 let mut cfg_options = CfgOptions::default();
539 // Some nightly-only cfgs, which are required for stdlib
541 cfg_options.insert_atom("target_thread_local".into());
542 for &target_has_atomic in ["8", "16", "32", "64", "cas", "ptr"].iter() {
543 cfg_options.insert_key_value("target_has_atomic".into(), target_has_atomic.into());
545 .insert_key_value("target_has_atomic_load_store".into(), target_has_atomic.into());
549 let rustc_cfgs = || -> Result<String> {
550 // `cfg(test)` and `cfg(debug_assertion)` are handled outside, so we suppress them here.
551 let mut cmd = Command::new(ra_toolchain::rustc());
552 cmd.args(&["--print", "cfg", "-O"]);
553 if let Some(target) = target {
554 cmd.args(&["--target", target.as_str()]);
556 let output = output(cmd)?;
557 Ok(String::from_utf8(output.stdout)?)
562 for line in rustc_cfgs.lines() {
563 match line.find('=') {
564 None => cfg_options.insert_atom(line.into()),
566 let key = &line[..pos];
567 let value = line[pos + 1..].trim_matches('"');
568 cfg_options.insert_key_value(key.into(), value.into());
573 Err(e) => log::error!("failed to get rustc cfgs: {:#}", e),
579 fn output(mut cmd: Command) -> Result<Output> {
580 let output = cmd.output().with_context(|| format!("{:?} failed", cmd))?;
581 if !output.status.success() {
582 match String::from_utf8(output.stderr) {
583 Ok(stderr) if !stderr.is_empty() => {
584 bail!("{:?} failed, {}\nstderr:\n{}", cmd, output.status, stderr)
586 _ => bail!("{:?} failed, {}", cmd, output.status),