crates/ra_project_model/src/lib.rs

   1 //! FIXME: write short doc here
   2
   3 mod cargo_workspace;
   4 mod json_project;
   5 mod sysroot;
   6
   7 use std::{
   8     fs::{read_dir, File, ReadDir},
   9     io::{self, BufReader},
  10     path::{Path, PathBuf},
  11     process::{Command, Output},
  12 };
  13
  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;
  19
  20 pub use crate::{
  21     cargo_workspace::{CargoConfig, CargoWorkspace, Package, Target, TargetKind},
  22     json_project::JsonProject,
  23     sysroot::Sysroot,
  24 };
  25 pub use ra_proc_macro::ProcMacroClient;
  26
  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 },
  33 }
  34
  35 /// `PackageRoot` describes a package root folder.
  36 /// Which may be an external dependency, or a member of
  37 /// the current workspace.
  38 #[derive(Clone)]
  39 pub struct PackageRoot {
  40     /// Path to the root folder
  41     path: PathBuf,
  42     /// Is a member of the current workspace
  43     is_member: bool,
  44 }
  45 impl PackageRoot {
  46     pub fn new_member(path: PathBuf) -> PackageRoot {
  47         Self { path, is_member: true }
  48     }
  49     pub fn new_non_member(path: PathBuf) -> PackageRoot {
  50         Self { path, is_member: false }
  51     }
  52     pub fn path(&self) -> &Path {
  53         &self.path
  54     }
  55     pub fn is_member(&self) -> bool {
  56         self.is_member
  57     }
  58 }
  59
  60 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
  61 pub enum ProjectRoot {
  62     ProjectJson(PathBuf),
  63     CargoToml(PathBuf),
  64 }
  65
  66 impl 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));
  70         }
  71         if path.ends_with("Cargo.toml") {
  72             return Ok(ProjectRoot::CargoToml(path));
  73         }
  74         bail!("project root must point to Cargo.toml or rust-project.json: {}", path.display())
  75     }
  76
  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"),
  81             Some(it) => it,
  82         };
  83
  84         if !candidates.is_empty() {
  85             bail!("more than one project")
  86         }
  87         Ok(res)
  88     }
  89
  90     pub fn discover(path: &Path) -> io::Result<Vec<ProjectRoot>> {
  91         if let Some(project_json) = find_rust_project_json(path) {
  92             return Ok(vec![ProjectRoot::ProjectJson(project_json)]);
  93         }
  94         return find_cargo_toml(path)
  95             .map(|paths| paths.into_iter().map(ProjectRoot::CargoToml).collect());
  96
  97         fn find_rust_project_json(path: &Path) -> Option<PathBuf> {
  98             if path.ends_with("rust-project.json") {
  99                 return Some(path.to_path_buf());
 100             }
 101
 102             let mut curr = Some(path);
 103             while let Some(path) = curr {
 104                 let candidate = path.join("rust-project.json");
 105                 if candidate.exists() {
 106                     return Some(candidate);
 107                 }
 108                 curr = path.parent();
 109             }
 110
 111             None
 112         }
 113
 114         fn find_cargo_toml(path: &Path) -> io::Result<Vec<PathBuf>> {
 115             if path.ends_with("Cargo.toml") {
 116                 return Ok(vec![path.to_path_buf()]);
 117             }
 118
 119             if let Some(p) = find_cargo_toml_in_parent_dir(path) {
 120                 return Ok(vec![p]);
 121             }
 122
 123             let entities = read_dir(path)?;
 124             Ok(find_cargo_toml_in_child_dir(entities))
 125         }
 126
 127         fn find_cargo_toml_in_parent_dir(path: &Path) -> Option<PathBuf> {
 128             let mut curr = Some(path);
 129             while let Some(path) = curr {
 130                 let candidate = path.join("Cargo.toml");
 131                 if candidate.exists() {
 132                     return Some(candidate);
 133                 }
 134                 curr = path.parent();
 135             }
 136
 137             None
 138         }
 139
 140         fn find_cargo_toml_in_child_dir(entities: ReadDir) -> Vec<PathBuf> {
 141             // Only one level down to avoid cycles the easy way and stop a runaway scan with large projects
 142             let mut valid_canditates = vec![];
 143             for entity in entities.filter_map(Result::ok) {
 144                 let candidate = entity.path().join("Cargo.toml");
 145                 if candidate.exists() {
 146                     valid_canditates.push(candidate)
 147                 }
 148             }
 149             valid_canditates
 150         }
 151     }
 152 }
 153
 154 impl ProjectWorkspace {
 155     pub fn load(
 156         root: ProjectRoot,
 157         cargo_features: &CargoConfig,
 158         with_sysroot: bool,
 159     ) -> Result<ProjectWorkspace> {
 160         let res = match root {
 161             ProjectRoot::ProjectJson(project_json) => {
 162                 let file = File::open(&project_json).with_context(|| {
 163                     format!("Failed to open json file {}", project_json.display())
 164                 })?;
 165                 let reader = BufReader::new(file);
 166                 ProjectWorkspace::Json {
 167                     project: from_reader(reader).with_context(|| {
 168                         format!("Failed to deserialize json file {}", project_json.display())
 169                     })?,
 170                 }
 171             }
 172             ProjectRoot::CargoToml(cargo_toml) => {
 173                 let cargo = CargoWorkspace::from_cargo_metadata(&cargo_toml, cargo_features)
 174                     .with_context(|| {
 175                         format!(
 176                             "Failed to read Cargo metadata from Cargo.toml file {}",
 177                             cargo_toml.display()
 178                         )
 179                     })?;
 180                 let sysroot = if with_sysroot {
 181                     Sysroot::discover(&cargo_toml).with_context(|| {
 182                         format!(
 183                             "Failed to find sysroot for Cargo.toml file {}. Is rust-src installed?",
 184                             cargo_toml.display()
 185                         )
 186                     })?
 187                 } else {
 188                     Sysroot::default()
 189                 };
 190                 ProjectWorkspace::Cargo { cargo, sysroot }
 191             }
 192         };
 193
 194         Ok(res)
 195     }
 196
 197     /// Returns the roots for the current `ProjectWorkspace`
 198     /// The return type contains the path and whether or not
 199     /// the root is a member of the current workspace
 200     pub fn to_roots(&self) -> Vec<PackageRoot> {
 201         match self {
 202             ProjectWorkspace::Json { project } => {
 203                 project.roots.iter().map(|r| PackageRoot::new_member(r.path.clone())).collect()
 204             }
 205             ProjectWorkspace::Cargo { cargo, sysroot } => cargo
 206                 .packages()
 207                 .map(|pkg| PackageRoot {
 208                     path: cargo[pkg].root().to_path_buf(),
 209                     is_member: cargo[pkg].is_member,
 210                 })
 211                 .chain(sysroot.crates().map(|krate| {
 212                     PackageRoot::new_non_member(sysroot[krate].root_dir().to_path_buf())
 213                 }))
 214                 .collect(),
 215         }
 216     }
 217
 218     pub fn out_dirs(&self) -> Vec<PathBuf> {
 219         match self {
 220             ProjectWorkspace::Json { project } => {
 221                 project.crates.iter().filter_map(|krate| krate.out_dir.as_ref()).cloned().collect()
 222             }
 223             ProjectWorkspace::Cargo { cargo, sysroot: _ } => {
 224                 cargo.packages().filter_map(|pkg| cargo[pkg].out_dir.as_ref()).cloned().collect()
 225             }
 226         }
 227     }
 228
 229     pub fn proc_macro_dylib_paths(&self) -> Vec<PathBuf> {
 230         match self {
 231             ProjectWorkspace::Json { project } => project
 232                 .crates
 233                 .iter()
 234                 .filter_map(|krate| krate.proc_macro_dylib_path.as_ref())
 235                 .cloned()
 236                 .collect(),
 237             ProjectWorkspace::Cargo { cargo, sysroot: _sysroot } => cargo
 238                 .packages()
 239                 .filter_map(|pkg| cargo[pkg].proc_macro_dylib_path.as_ref())
 240                 .cloned()
 241                 .collect(),
 242         }
 243     }
 244
 245     pub fn n_packages(&self) -> usize {
 246         match self {
 247             ProjectWorkspace::Json { project } => project.crates.len(),
 248             ProjectWorkspace::Cargo { cargo, sysroot } => {
 249                 cargo.packages().len() + sysroot.crates().len()
 250             }
 251         }
 252     }
 253
 254     pub fn to_crate_graph(
 255         &self,
 256         default_cfg_options: &CfgOptions,
 257         extern_source_roots: &FxHashMap<PathBuf, ExternSourceId>,
 258         proc_macro_client: &ProcMacroClient,
 259         load: &mut dyn FnMut(&Path) -> Option<FileId>,
 260     ) -> CrateGraph {
 261         let mut crate_graph = CrateGraph::default();
 262         match self {
 263             ProjectWorkspace::Json { project } => {
 264                 let crates: FxHashMap<_, _> = project
 265                     .crates
 266                     .iter()
 267                     .enumerate()
 268                     .filter_map(|(seq_index, krate)| {
 269                         let file_id = load(&krate.root_module)?;
 270                         let edition = match krate.edition {
 271                             json_project::Edition::Edition2015 => Edition::Edition2015,
 272                             json_project::Edition::Edition2018 => Edition::Edition2018,
 273                         };
 274                         let cfg_options = {
 275                             let mut opts = default_cfg_options.clone();
 276                             for name in &krate.atom_cfgs {
 277                                 opts.insert_atom(name.into());
 278                             }
 279                             for (key, value) in &krate.key_value_cfgs {
 280                                 opts.insert_key_value(key.into(), value.into());
 281                             }
 282                             opts
 283                         };
 284
 285                         let mut env = Env::default();
 286                         let mut extern_source = ExternSource::default();
 287                         if let Some(out_dir) = &krate.out_dir {
 288                             // NOTE: cargo and rustc seem to hide non-UTF-8 strings from env! and option_env!()
 289                             if let Some(out_dir) = out_dir.to_str().map(|s| s.to_owned()) {
 290                                 env.set("OUT_DIR", out_dir);
 291                             }
 292                             if let Some(&extern_source_id) = extern_source_roots.get(out_dir) {
 293                                 extern_source.set_extern_path(&out_dir, extern_source_id);
 294                             }
 295                         }
 296                         let proc_macro = krate
 297                             .proc_macro_dylib_path
 298                             .clone()
 299                             .map(|it| proc_macro_client.by_dylib_path(&it));
 300                         // FIXME: No crate name in json definition such that we cannot add OUT_DIR to env
 301                         Some((
 302                             json_project::CrateId(seq_index),
 303                             crate_graph.add_crate_root(
 304                                 file_id,
 305                                 edition,
 306                                 // FIXME json definitions can store the crate name
 307                                 None,
 308                                 cfg_options,
 309                                 env,
 310                                 extern_source,
 311                                 proc_macro.unwrap_or_default(),
 312                             ),
 313                         ))
 314                     })
 315                     .collect();
 316
 317                 for (id, krate) in project.crates.iter().enumerate() {
 318                     for dep in &krate.deps {
 319                         let from_crate_id = json_project::CrateId(id);
 320                         let to_crate_id = dep.krate;
 321                         if let (Some(&from), Some(&to)) =
 322                             (crates.get(&from_crate_id), crates.get(&to_crate_id))
 323                         {
 324                             if crate_graph
 325                                 .add_dep(from, CrateName::new(&dep.name).unwrap(), to)
 326                                 .is_err()
 327                             {
 328                                 log::error!(
 329                                     "cyclic dependency {:?} -> {:?}",
 330                                     from_crate_id,
 331                                     to_crate_id
 332                                 );
 333                             }
 334                         }
 335                     }
 336                 }
 337             }
 338             ProjectWorkspace::Cargo { cargo, sysroot } => {
 339                 let sysroot_crates: FxHashMap<_, _> = sysroot
 340                     .crates()
 341                     .filter_map(|krate| {
 342                         let file_id = load(&sysroot[krate].root)?;
 343
 344                         // Crates from sysroot have `cfg(test)` disabled
 345                         let cfg_options = {
 346                             let mut opts = default_cfg_options.clone();
 347                             opts.remove_atom("test");
 348                             opts
 349                         };
 350
 351                         let env = Env::default();
 352                         let extern_source = ExternSource::default();
 353                         let proc_macro = vec![];
 354                         let crate_name = CrateName::new(&sysroot[krate].name)
 355                             .expect("Sysroot crate names should not contain dashes");
 356
 357                         let crate_id = crate_graph.add_crate_root(
 358                             file_id,
 359                             Edition::Edition2018,
 360                             Some(crate_name),
 361                             cfg_options,
 362                             env,
 363                             extern_source,
 364                             proc_macro,
 365                         );
 366                         Some((krate, crate_id))
 367                     })
 368                     .collect();
 369
 370                 for from in sysroot.crates() {
 371                     for &to in sysroot[from].deps.iter() {
 372                         let name = &sysroot[to].name;
 373                         if let (Some(&from), Some(&to)) =
 374                             (sysroot_crates.get(&from), sysroot_crates.get(&to))
 375                         {
 376                             if crate_graph.add_dep(from, CrateName::new(name).unwrap(), to).is_err()
 377                             {
 378                                 log::error!("cyclic dependency between sysroot crates")
 379                             }
 380                         }
 381                     }
 382                 }
 383
 384                 let libcore = sysroot.core().and_then(|it| sysroot_crates.get(&it).copied());
 385                 let liballoc = sysroot.alloc().and_then(|it| sysroot_crates.get(&it).copied());
 386                 let libstd = sysroot.std().and_then(|it| sysroot_crates.get(&it).copied());
 387                 let libproc_macro =
 388                     sysroot.proc_macro().and_then(|it| sysroot_crates.get(&it).copied());
 389
 390                 let mut pkg_to_lib_crate = FxHashMap::default();
 391                 let mut pkg_crates = FxHashMap::default();
 392                 // Next, create crates for each package, target pair
 393                 for pkg in cargo.packages() {
 394                     let mut lib_tgt = None;
 395                     for &tgt in cargo[pkg].targets.iter() {
 396                         let root = cargo[tgt].root.as_path();
 397                         if let Some(file_id) = load(root) {
 398                             let edition = cargo[pkg].edition;
 399                             let cfg_options = {
 400                                 let mut opts = default_cfg_options.clone();
 401                                 for feature in cargo[pkg].features.iter() {
 402                                     opts.insert_key_value("feature".into(), feature.into());
 403                                 }
 404                                 for cfg in cargo[pkg].cfgs.iter() {
 405                                     match cfg.find('=') {
 406                                         Some(split) => opts.insert_key_value(
 407                                             cfg[..split].into(),
 408                                             cfg[split + 1..].trim_matches('"').into(),
 409                                         ),
 410                                         None => opts.insert_atom(cfg.into()),
 411                                     };
 412                                 }
 413                                 opts
 414                             };
 415                             let mut env = Env::default();
 416                             let mut extern_source = ExternSource::default();
 417                             if let Some(out_dir) = &cargo[pkg].out_dir {
 418                                 // NOTE: cargo and rustc seem to hide non-UTF-8 strings from env! and option_env!()
 419                                 if let Some(out_dir) = out_dir.to_str().map(|s| s.to_owned()) {
 420                                     env.set("OUT_DIR", out_dir);
 421                                 }
 422                                 if let Some(&extern_source_id) = extern_source_roots.get(out_dir) {
 423                                     extern_source.set_extern_path(&out_dir, extern_source_id);
 424                                 }
 425                             }
 426                             let proc_macro = cargo[pkg]
 427                                 .proc_macro_dylib_path
 428                                 .as_ref()
 429                                 .map(|it| proc_macro_client.by_dylib_path(&it))
 430                                 .unwrap_or_default();
 431
 432                             let crate_id = crate_graph.add_crate_root(
 433                                 file_id,
 434                                 edition,
 435                                 Some(CrateName::normalize_dashes(&cargo[pkg].name)),
 436                                 cfg_options,
 437                                 env,
 438                                 extern_source,
 439                                 proc_macro.clone(),
 440                             );
 441                             if cargo[tgt].kind == TargetKind::Lib {
 442                                 lib_tgt = Some((crate_id, cargo[tgt].name.clone()));
 443                                 pkg_to_lib_crate.insert(pkg, crate_id);
 444                             }
 445                             if cargo[tgt].is_proc_macro {
 446                                 if let Some(proc_macro) = libproc_macro {
 447                                     if crate_graph
 448                                         .add_dep(
 449                                             crate_id,
 450                                             CrateName::new("proc_macro").unwrap(),
 451                                             proc_macro,
 452                                         )
 453                                         .is_err()
 454                                     {
 455                                         log::error!(
 456                                             "cyclic dependency on proc_macro for {}",
 457                                             &cargo[pkg].name
 458                                         )
 459                                     }
 460                                 }
 461                             }
 462
 463                             pkg_crates.entry(pkg).or_insert_with(Vec::new).push(crate_id);
 464                         }
 465                     }
 466
 467                     // Set deps to the core, std and to the lib target of the current package
 468                     for &from in pkg_crates.get(&pkg).into_iter().flatten() {
 469                         if let Some((to, name)) = lib_tgt.clone() {
 470                             if to != from
 471                                 && crate_graph
 472                                     .add_dep(
 473                                         from,
 474                                         // For root projects with dashes in their name,
 475                                         // cargo metadata does not do any normalization,
 476                                         // so we do it ourselves currently
 477                                         CrateName::normalize_dashes(&name),
 478                                         to,
 479                                     )
 480                                     .is_err()
 481                             {
 482                                 {
 483                                     log::error!(
 484                                         "cyclic dependency between targets of {}",
 485                                         &cargo[pkg].name
 486                                     )
 487                                 }
 488                             }
 489                         }
 490                         // core is added as a dependency before std in order to
 491                         // mimic rustcs dependency order
 492                         if let Some(core) = libcore {
 493                             if crate_graph
 494                                 .add_dep(from, CrateName::new("core").unwrap(), core)
 495                                 .is_err()
 496                             {
 497                                 log::error!("cyclic dependency on core for {}", &cargo[pkg].name)
 498                             }
 499                         }
 500                         if let Some(alloc) = liballoc {
 501                             if crate_graph
 502                                 .add_dep(from, CrateName::new("alloc").unwrap(), alloc)
 503                                 .is_err()
 504                             {
 505                                 log::error!("cyclic dependency on alloc for {}", &cargo[pkg].name)
 506                             }
 507                         }
 508                         if let Some(std) = libstd {
 509                             if crate_graph
 510                                 .add_dep(from, CrateName::new("std").unwrap(), std)
 511                                 .is_err()
 512                             {
 513                                 log::error!("cyclic dependency on std for {}", &cargo[pkg].name)
 514                             }
 515                         }
 516                     }
 517                 }
 518
 519                 // Now add a dep edge from all targets of upstream to the lib
 520                 // target of downstream.
 521                 for pkg in cargo.packages() {
 522                     for dep in cargo[pkg].dependencies.iter() {
 523                         if let Some(&to) = pkg_to_lib_crate.get(&dep.pkg) {
 524                             for &from in pkg_crates.get(&pkg).into_iter().flatten() {
 525                                 if crate_graph
 526                                     .add_dep(from, CrateName::new(&dep.name).unwrap(), to)
 527                                     .is_err()
 528                                 {
 529                                     log::error!(
 530                                         "cyclic dependency {} -> {}",
 531                                         &cargo[pkg].name,
 532                                         &cargo[dep.pkg].name
 533                                     )
 534                                 }
 535                             }
 536                         }
 537                     }
 538                 }
 539             }
 540         }
 541         crate_graph
 542     }
 543
 544     pub fn workspace_root_for(&self, path: &Path) -> Option<&Path> {
 545         match self {
 546             ProjectWorkspace::Cargo { cargo, .. } => {
 547                 Some(cargo.workspace_root()).filter(|root| path.starts_with(root))
 548             }
 549             ProjectWorkspace::Json { project: JsonProject { roots, .. } } => roots
 550                 .iter()
 551                 .find(|root| path.starts_with(&root.path))
 552                 .map(|root| root.path.as_ref()),
 553         }
 554     }
 555 }
 556
 557 pub fn get_rustc_cfg_options(target: Option<&String>) -> CfgOptions {
 558     let mut cfg_options = CfgOptions::default();
 559
 560     // Some nightly-only cfgs, which are required for stdlib
 561     {
 562         cfg_options.insert_atom("target_thread_local".into());
 563         for &target_has_atomic in ["8", "16", "32", "64", "cas", "ptr"].iter() {
 564             cfg_options.insert_key_value("target_has_atomic".into(), target_has_atomic.into());
 565             cfg_options
 566                 .insert_key_value("target_has_atomic_load_store".into(), target_has_atomic.into());
 567         }
 568     }
 569
 570     let rustc_cfgs = || -> Result<String> {
 571         // `cfg(test)` and `cfg(debug_assertion)` are handled outside, so we suppress them here.
 572         let mut cmd = Command::new(ra_toolchain::rustc());
 573         cmd.args(&["--print", "cfg", "-O"]);
 574         if let Some(target) = target {
 575             cmd.args(&["--target", target.as_str()]);
 576         }
 577         let output = output(cmd)?;
 578         Ok(String::from_utf8(output.stdout)?)
 579     }();
 580
 581     match rustc_cfgs {
 582         Ok(rustc_cfgs) => {
 583             for line in rustc_cfgs.lines() {
 584                 match line.find('=') {
 585                     None => cfg_options.insert_atom(line.into()),
 586                     Some(pos) => {
 587                         let key = &line[..pos];
 588                         let value = line[pos + 1..].trim_matches('"');
 589                         cfg_options.insert_key_value(key.into(), value.into());
 590                     }
 591                 }
 592             }
 593         }
 594         Err(e) => log::error!("failed to get rustc cfgs: {:#}", e),
 595     }
 596
 597     cfg_options
 598 }
 599
 600 fn output(mut cmd: Command) -> Result<Output> {
 601     let output = cmd.output().with_context(|| format!("{:?} failed", cmd))?;
 602     if !output.status.success() {
 603         match String::from_utf8(output.stderr) {
 604             Ok(stderr) if !stderr.is_empty() => {
 605                 bail!("{:?} failed, {}\nstderr:\n{}", cmd, output.status, stderr)
 606             }
 607             _ => bail!("{:?} failed, {}", cmd, output.status),
 608         }
 609     }
 610     Ok(output)
 611 }