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,
  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 cfg in &krate.cfg {
 277                                 match cfg.find('=') {
 278                                     None => opts.insert_atom(cfg.into()),
 279                                     Some(pos) => {
 280                                         let key = &cfg[..pos];
 281                                         let value = cfg[pos + 1..].trim_matches('"');
 282                                         opts.insert_key_value(key.into(), value.into());
 283                                     }
 284                                 }
 285                             }
 286                             for name in &krate.atom_cfgs {
 287                                 opts.insert_atom(name.into());
 288                             }
 289                             for (key, value) in &krate.key_value_cfgs {
 290                                 opts.insert_key_value(key.into(), value.into());
 291                             }
 292                             opts
 293                         };
 294
 295                         let mut env = Env::default();
 296                         let mut extern_source = ExternSource::default();
 297                         if let Some(out_dir) = &krate.out_dir {
 298                             // NOTE: cargo and rustc seem to hide non-UTF-8 strings from env! and option_env!()
 299                             if let Some(out_dir) = out_dir.to_str().map(|s| s.to_owned()) {
 300                                 env.set("OUT_DIR", out_dir);
 301                             }
 302                             if let Some(&extern_source_id) = extern_source_roots.get(out_dir) {
 303                                 extern_source.set_extern_path(&out_dir, extern_source_id);
 304                             }
 305                         }
 306                         let proc_macro = krate
 307                             .proc_macro_dylib_path
 308                             .clone()
 309                             .map(|it| proc_macro_client.by_dylib_path(&it));
 310                         // FIXME: No crate name in json definition such that we cannot add OUT_DIR to env
 311                         Some((
 312                             json_project::CrateId(seq_index),
 313                             crate_graph.add_crate_root(
 314                                 file_id,
 315                                 edition,
 316                                 // FIXME json definitions can store the crate name
 317                                 None,
 318                                 cfg_options,
 319                                 env,
 320                                 extern_source,
 321                                 proc_macro.unwrap_or_default(),
 322                             ),
 323                         ))
 324                     })
 325                     .collect();
 326
 327                 for (id, krate) in project.crates.iter().enumerate() {
 328                     for dep in &krate.deps {
 329                         let from_crate_id = json_project::CrateId(id);
 330                         let to_crate_id = dep.krate;
 331                         if let (Some(&from), Some(&to)) =
 332                             (crates.get(&from_crate_id), crates.get(&to_crate_id))
 333                         {
 334                             if crate_graph
 335                                 .add_dep(from, CrateName::new(&dep.name).unwrap(), to)
 336                                 .is_err()
 337                             {
 338                                 log::error!(
 339                                     "cyclic dependency {:?} -> {:?}",
 340                                     from_crate_id,
 341                                     to_crate_id
 342                                 );
 343                             }
 344                         }
 345                     }
 346                 }
 347             }
 348             ProjectWorkspace::Cargo { cargo, sysroot } => {
 349                 let sysroot_crates: FxHashMap<_, _> = sysroot
 350                     .crates()
 351                     .filter_map(|krate| {
 352                         let file_id = load(&sysroot[krate].root)?;
 353
 354                         // Crates from sysroot have `cfg(test)` disabled
 355                         let cfg_options = {
 356                             let mut opts = default_cfg_options.clone();
 357                             opts.remove_atom("test");
 358                             opts
 359                         };
 360
 361                         let env = Env::default();
 362                         let extern_source = ExternSource::default();
 363                         let proc_macro = vec![];
 364                         let crate_name = CrateName::new(&sysroot[krate].name)
 365                             .expect("Sysroot crate names should not contain dashes");
 366
 367                         let crate_id = crate_graph.add_crate_root(
 368                             file_id,
 369                             Edition::Edition2018,
 370                             Some(crate_name),
 371                             cfg_options,
 372                             env,
 373                             extern_source,
 374                             proc_macro,
 375                         );
 376                         Some((krate, crate_id))
 377                     })
 378                     .collect();
 379
 380                 for from in sysroot.crates() {
 381                     for &to in sysroot[from].deps.iter() {
 382                         let name = &sysroot[to].name;
 383                         if let (Some(&from), Some(&to)) =
 384                             (sysroot_crates.get(&from), sysroot_crates.get(&to))
 385                         {
 386                             if crate_graph.add_dep(from, CrateName::new(name).unwrap(), to).is_err()
 387                             {
 388                                 log::error!("cyclic dependency between sysroot crates")
 389                             }
 390                         }
 391                     }
 392                 }
 393
 394                 let libcore = sysroot.core().and_then(|it| sysroot_crates.get(&it).copied());
 395                 let liballoc = sysroot.alloc().and_then(|it| sysroot_crates.get(&it).copied());
 396                 let libstd = sysroot.std().and_then(|it| sysroot_crates.get(&it).copied());
 397                 let libproc_macro =
 398                     sysroot.proc_macro().and_then(|it| sysroot_crates.get(&it).copied());
 399
 400                 let mut pkg_to_lib_crate = FxHashMap::default();
 401                 let mut pkg_crates = FxHashMap::default();
 402                 // Next, create crates for each package, target pair
 403                 for pkg in cargo.packages() {
 404                     let mut lib_tgt = None;
 405                     for &tgt in cargo[pkg].targets.iter() {
 406                         let root = cargo[tgt].root.as_path();
 407                         if let Some(file_id) = load(root) {
 408                             let edition = cargo[pkg].edition;
 409                             let cfg_options = {
 410                                 let mut opts = default_cfg_options.clone();
 411                                 opts.insert_features(cargo[pkg].features.iter().map(Into::into));
 412                                 opts
 413                             };
 414                             let mut env = Env::default();
 415                             let mut extern_source = ExternSource::default();
 416                             if let Some(out_dir) = &cargo[pkg].out_dir {
 417                                 // NOTE: cargo and rustc seem to hide non-UTF-8 strings from env! and option_env!()
 418                                 if let Some(out_dir) = out_dir.to_str().map(|s| s.to_owned()) {
 419                                     env.set("OUT_DIR", out_dir);
 420                                 }
 421                                 if let Some(&extern_source_id) = extern_source_roots.get(out_dir) {
 422                                     extern_source.set_extern_path(&out_dir, extern_source_id);
 423                                 }
 424                             }
 425                             let proc_macro = cargo[pkg]
 426                                 .proc_macro_dylib_path
 427                                 .as_ref()
 428                                 .map(|it| proc_macro_client.by_dylib_path(&it))
 429                                 .unwrap_or_default();
 430
 431                             let crate_id = crate_graph.add_crate_root(
 432                                 file_id,
 433                                 edition,
 434                                 Some(CrateName::normalize_dashes(&cargo[pkg].name)),
 435                                 cfg_options,
 436                                 env,
 437                                 extern_source,
 438                                 proc_macro.clone(),
 439                             );
 440                             if cargo[tgt].kind == TargetKind::Lib {
 441                                 lib_tgt = Some((crate_id, cargo[tgt].name.clone()));
 442                                 pkg_to_lib_crate.insert(pkg, crate_id);
 443                             }
 444                             if cargo[tgt].is_proc_macro {
 445                                 if let Some(proc_macro) = libproc_macro {
 446                                     if crate_graph
 447                                         .add_dep(
 448                                             crate_id,
 449                                             CrateName::new("proc_macro").unwrap(),
 450                                             proc_macro,
 451                                         )
 452                                         .is_err()
 453                                     {
 454                                         log::error!(
 455                                             "cyclic dependency on proc_macro for {}",
 456                                             &cargo[pkg].name
 457                                         )
 458                                     }
 459                                 }
 460                             }
 461
 462                             pkg_crates.entry(pkg).or_insert_with(Vec::new).push(crate_id);
 463                         }
 464                     }
 465
 466                     // Set deps to the core, std and to the lib target of the current package
 467                     for &from in pkg_crates.get(&pkg).into_iter().flatten() {
 468                         if let Some((to, name)) = lib_tgt.clone() {
 469                             if to != from
 470                                 && crate_graph
 471                                     .add_dep(
 472                                         from,
 473                                         // For root projects with dashes in their name,
 474                                         // cargo metadata does not do any normalization,
 475                                         // so we do it ourselves currently
 476                                         CrateName::normalize_dashes(&name),
 477                                         to,
 478                                     )
 479                                     .is_err()
 480                             {
 481                                 {
 482                                     log::error!(
 483                                         "cyclic dependency between targets of {}",
 484                                         &cargo[pkg].name
 485                                     )
 486                                 }
 487                             }
 488                         }
 489                         // core is added as a dependency before std in order to
 490                         // mimic rustcs dependency order
 491                         if let Some(core) = libcore {
 492                             if crate_graph
 493                                 .add_dep(from, CrateName::new("core").unwrap(), core)
 494                                 .is_err()
 495                             {
 496                                 log::error!("cyclic dependency on core for {}", &cargo[pkg].name)
 497                             }
 498                         }
 499                         if let Some(alloc) = liballoc {
 500                             if crate_graph
 501                                 .add_dep(from, CrateName::new("alloc").unwrap(), alloc)
 502                                 .is_err()
 503                             {
 504                                 log::error!("cyclic dependency on alloc for {}", &cargo[pkg].name)
 505                             }
 506                         }
 507                         if let Some(std) = libstd {
 508                             if crate_graph
 509                                 .add_dep(from, CrateName::new("std").unwrap(), std)
 510                                 .is_err()
 511                             {
 512                                 log::error!("cyclic dependency on std for {}", &cargo[pkg].name)
 513                             }
 514                         }
 515                     }
 516                 }
 517
 518                 // Now add a dep edge from all targets of upstream to the lib
 519                 // target of downstream.
 520                 for pkg in cargo.packages() {
 521                     for dep in cargo[pkg].dependencies.iter() {
 522                         if let Some(&to) = pkg_to_lib_crate.get(&dep.pkg) {
 523                             for &from in pkg_crates.get(&pkg).into_iter().flatten() {
 524                                 if crate_graph
 525                                     .add_dep(from, CrateName::new(&dep.name).unwrap(), to)
 526                                     .is_err()
 527                                 {
 528                                     log::error!(
 529                                         "cyclic dependency {} -> {}",
 530                                         &cargo[pkg].name,
 531                                         &cargo[dep.pkg].name
 532                                     )
 533                                 }
 534                             }
 535                         }
 536                     }
 537                 }
 538             }
 539         }
 540         crate_graph
 541     }
 542
 543     pub fn workspace_root_for(&self, path: &Path) -> Option<&Path> {
 544         match self {
 545             ProjectWorkspace::Cargo { cargo, .. } => {
 546                 Some(cargo.workspace_root()).filter(|root| path.starts_with(root))
 547             }
 548             ProjectWorkspace::Json { project: JsonProject { roots, .. } } => roots
 549                 .iter()
 550                 .find(|root| path.starts_with(&root.path))
 551                 .map(|root| root.path.as_ref()),
 552         }
 553     }
 554 }
 555
 556 pub fn get_rustc_cfg_options() -> CfgOptions {
 557     let mut cfg_options = CfgOptions::default();
 558
 559     // Some nightly-only cfgs, which are required for stdlib
 560     {
 561         cfg_options.insert_atom("target_thread_local".into());
 562         for &target_has_atomic in ["8", "16", "32", "64", "cas", "ptr"].iter() {
 563             cfg_options.insert_key_value("target_has_atomic".into(), target_has_atomic.into());
 564             cfg_options
 565                 .insert_key_value("target_has_atomic_load_store".into(), target_has_atomic.into());
 566         }
 567     }
 568
 569     match (|| -> Result<String> {
 570         // `cfg(test)` and `cfg(debug_assertion)` are handled outside, so we suppress them here.
 571         let output = Command::new("rustc")
 572             .args(&["--print", "cfg", "-O"])
 573             .output()
 574             .context("Failed to get output from rustc --print cfg -O")?;
 575         if !output.status.success() {
 576             bail!(
 577                 "rustc --print cfg -O exited with exit code ({})",
 578                 output
 579                     .status
 580                     .code()
 581                     .map_or(String::from("no exit code"), |code| format!("{}", code))
 582             );
 583         }
 584         Ok(String::from_utf8(output.stdout)?)
 585     })() {
 586         Ok(rustc_cfgs) => {
 587             for line in rustc_cfgs.lines() {
 588                 match line.find('=') {
 589                     None => cfg_options.insert_atom(line.into()),
 590                     Some(pos) => {
 591                         let key = &line[..pos];
 592                         let value = line[pos + 1..].trim_matches('"');
 593                         cfg_options.insert_key_value(key.into(), value.into());
 594                     }
 595                 }
 596             }
 597         }
 598         Err(e) => log::error!("failed to get rustc cfgs: {}", e),
 599     }
 600
 601     cfg_options
 602 }