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