aboutsummaryrefslogtreecommitdiff
path: root/crates/project_model/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'crates/project_model/src/lib.rs')
-rw-r--r--crates/project_model/src/lib.rs469
1 files changed, 4 insertions, 465 deletions
diff --git a/crates/project_model/src/lib.rs b/crates/project_model/src/lib.rs
index e92cfea59..24aa9b8fa 100644
--- a/crates/project_model/src/lib.rs
+++ b/crates/project_model/src/lib.rs
@@ -4,69 +4,27 @@ mod cargo_workspace;
4mod project_json; 4mod project_json;
5mod sysroot; 5mod sysroot;
6mod cfg_flag; 6mod cfg_flag;
7mod workspace;
7 8
8use std::{ 9use std::{
9 fmt, 10 fs::{read_dir, ReadDir},
10 fs::{self, read_dir, ReadDir},
11 io, 11 io,
12 process::Command, 12 process::Command,
13}; 13};
14 14
15use anyhow::{bail, Context, Result}; 15use anyhow::{bail, Context, Result};
16use base_db::{CrateDisplayName, CrateGraph, CrateId, CrateName, Edition, Env, FileId};
17use cfg::CfgOptions;
18use paths::{AbsPath, AbsPathBuf}; 16use paths::{AbsPath, AbsPathBuf};
19use rustc_hash::{FxHashMap, FxHashSet}; 17use rustc_hash::FxHashSet;
20
21use crate::cfg_flag::CfgFlag;
22 18
23pub use crate::{ 19pub use crate::{
24 cargo_workspace::{CargoConfig, CargoWorkspace, Package, Target, TargetKind}, 20 cargo_workspace::{CargoConfig, CargoWorkspace, Package, Target, TargetKind},
25 project_json::{ProjectJson, ProjectJsonData}, 21 project_json::{ProjectJson, ProjectJsonData},
26 sysroot::Sysroot, 22 sysroot::Sysroot,
23 workspace::{PackageRoot, ProjectWorkspace},
27}; 24};
28 25
29pub use proc_macro_api::ProcMacroClient; 26pub use proc_macro_api::ProcMacroClient;
30 27
31#[derive(Clone, Eq, PartialEq)]
32pub enum ProjectWorkspace {
33 /// Project workspace was discovered by running `cargo metadata` and `rustc --print sysroot`.
34 Cargo { cargo: CargoWorkspace, sysroot: Sysroot },
35 /// Project workspace was manually specified using a `rust-project.json` file.
36 Json { project: ProjectJson, sysroot: Option<Sysroot> },
37}
38
39impl fmt::Debug for ProjectWorkspace {
40 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
41 match self {
42 ProjectWorkspace::Cargo { cargo, sysroot } => f
43 .debug_struct("Cargo")
44 .field("n_packages", &cargo.packages().len())
45 .field("n_sysroot_crates", &sysroot.crates().len())
46 .finish(),
47 ProjectWorkspace::Json { project, sysroot } => {
48 let mut debug_struct = f.debug_struct("Json");
49 debug_struct.field("n_crates", &project.n_crates());
50 if let Some(sysroot) = sysroot {
51 debug_struct.field("n_sysroot_crates", &sysroot.crates().len());
52 }
53 debug_struct.finish()
54 }
55 }
56 }
57}
58
59/// `PackageRoot` describes a package root folder.
60/// Which may be an external dependency, or a member of
61/// the current workspace.
62#[derive(Debug, Clone, Eq, PartialEq, Hash)]
63pub struct PackageRoot {
64 /// Is a member of the current workspace
65 pub is_member: bool,
66 pub include: Vec<AbsPathBuf>,
67 pub exclude: Vec<AbsPathBuf>,
68}
69
70#[derive(Debug, Clone, PartialEq, Eq, Hash, Ord, PartialOrd)] 28#[derive(Debug, Clone, PartialEq, Eq, Hash, Ord, PartialOrd)]
71pub enum ProjectManifest { 29pub enum ProjectManifest {
72 ProjectJson(AbsPathBuf), 30 ProjectJson(AbsPathBuf),
@@ -153,376 +111,6 @@ impl ProjectManifest {
153 } 111 }
154} 112}
155 113
156impl ProjectWorkspace {
157 pub fn load(
158 manifest: ProjectManifest,
159 cargo_config: &CargoConfig,
160 with_sysroot: bool,
161 ) -> Result<ProjectWorkspace> {
162 let res = match manifest {
163 ProjectManifest::ProjectJson(project_json) => {
164 let file = fs::read_to_string(&project_json).with_context(|| {
165 format!("Failed to read json file {}", project_json.display())
166 })?;
167 let data = serde_json::from_str(&file).with_context(|| {
168 format!("Failed to deserialize json file {}", project_json.display())
169 })?;
170 let project_location = project_json.parent().unwrap().to_path_buf();
171 let project = ProjectJson::new(&project_location, data);
172 let sysroot = match &project.sysroot_src {
173 Some(path) => Some(Sysroot::load(path)?),
174 None => None,
175 };
176 ProjectWorkspace::Json { project, sysroot }
177 }
178 ProjectManifest::CargoToml(cargo_toml) => {
179 let cargo_version = utf8_stdout({
180 let mut cmd = Command::new(toolchain::cargo());
181 cmd.arg("--version");
182 cmd
183 })?;
184
185 let cargo = CargoWorkspace::from_cargo_metadata(&cargo_toml, cargo_config)
186 .with_context(|| {
187 format!(
188 "Failed to read Cargo metadata from Cargo.toml file {}, {}",
189 cargo_toml.display(),
190 cargo_version
191 )
192 })?;
193 let sysroot = if with_sysroot {
194 Sysroot::discover(&cargo_toml).with_context(|| {
195 format!(
196 "Failed to find sysroot for Cargo.toml file {}. Is rust-src installed?",
197 cargo_toml.display()
198 )
199 })?
200 } else {
201 Sysroot::default()
202 };
203 ProjectWorkspace::Cargo { cargo, sysroot }
204 }
205 };
206
207 Ok(res)
208 }
209
210 pub fn load_inline(project_json: ProjectJson) -> Result<ProjectWorkspace> {
211 let sysroot = match &project_json.sysroot_src {
212 Some(path) => Some(Sysroot::load(path)?),
213 None => None,
214 };
215
216 Ok(ProjectWorkspace::Json { project: project_json, sysroot })
217 }
218
219 /// Returns the roots for the current `ProjectWorkspace`
220 /// The return type contains the path and whether or not
221 /// the root is a member of the current workspace
222 pub fn to_roots(&self) -> Vec<PackageRoot> {
223 match self {
224 ProjectWorkspace::Json { project, sysroot } => project
225 .crates()
226 .map(|(_, krate)| PackageRoot {
227 is_member: krate.is_workspace_member,
228 include: krate.include.clone(),
229 exclude: krate.exclude.clone(),
230 })
231 .collect::<FxHashSet<_>>()
232 .into_iter()
233 .chain(sysroot.as_ref().into_iter().flat_map(|sysroot| {
234 sysroot.crates().map(move |krate| PackageRoot {
235 is_member: false,
236 include: vec![sysroot[krate].root_dir().to_path_buf()],
237 exclude: Vec::new(),
238 })
239 }))
240 .collect::<Vec<_>>(),
241 ProjectWorkspace::Cargo { cargo, sysroot } => cargo
242 .packages()
243 .map(|pkg| {
244 let is_member = cargo[pkg].is_member;
245 let pkg_root = cargo[pkg].root().to_path_buf();
246
247 let mut include = vec![pkg_root.clone()];
248 include.extend(cargo[pkg].out_dir.clone());
249
250 let mut exclude = vec![pkg_root.join(".git")];
251 if is_member {
252 exclude.push(pkg_root.join("target"));
253 } else {
254 exclude.push(pkg_root.join("tests"));
255 exclude.push(pkg_root.join("examples"));
256 exclude.push(pkg_root.join("benches"));
257 }
258 PackageRoot { is_member, include, exclude }
259 })
260 .chain(sysroot.crates().map(|krate| PackageRoot {
261 is_member: false,
262 include: vec![sysroot[krate].root_dir().to_path_buf()],
263 exclude: Vec::new(),
264 }))
265 .collect(),
266 }
267 }
268
269 pub fn proc_macro_dylib_paths(&self) -> Vec<AbsPathBuf> {
270 match self {
271 ProjectWorkspace::Json { project, sysroot: _ } => project
272 .crates()
273 .filter_map(|(_, krate)| krate.proc_macro_dylib_path.as_ref())
274 .cloned()
275 .collect(),
276 ProjectWorkspace::Cargo { cargo, sysroot: _sysroot } => cargo
277 .packages()
278 .filter_map(|pkg| cargo[pkg].proc_macro_dylib_path.as_ref())
279 .cloned()
280 .collect(),
281 }
282 }
283
284 pub fn n_packages(&self) -> usize {
285 match self {
286 ProjectWorkspace::Json { project, .. } => project.n_crates(),
287 ProjectWorkspace::Cargo { cargo, sysroot } => {
288 cargo.packages().len() + sysroot.crates().len()
289 }
290 }
291 }
292
293 pub fn to_crate_graph(
294 &self,
295 target: Option<&str>,
296 proc_macro_client: &ProcMacroClient,
297 load: &mut dyn FnMut(&AbsPath) -> Option<FileId>,
298 ) -> CrateGraph {
299 let mut crate_graph = CrateGraph::default();
300 match self {
301 ProjectWorkspace::Json { project, sysroot } => {
302 let sysroot_dps = sysroot
303 .as_ref()
304 .map(|sysroot| sysroot_to_crate_graph(&mut crate_graph, sysroot, target, load));
305
306 let mut cfg_cache: FxHashMap<Option<&str>, Vec<CfgFlag>> = FxHashMap::default();
307 let crates: FxHashMap<_, _> = project
308 .crates()
309 .filter_map(|(crate_id, krate)| {
310 let file_path = &krate.root_module;
311 let file_id = match load(&file_path) {
312 Some(id) => id,
313 None => {
314 log::error!("failed to load crate root {}", file_path.display());
315 return None;
316 }
317 };
318
319 let env = krate.env.clone().into_iter().collect();
320 let proc_macro = krate
321 .proc_macro_dylib_path
322 .clone()
323 .map(|it| proc_macro_client.by_dylib_path(&it));
324
325 let target = krate.target.as_deref().or(target);
326 let target_cfgs = cfg_cache
327 .entry(target)
328 .or_insert_with(|| get_rustc_cfg_options(target));
329
330 let mut cfg_options = CfgOptions::default();
331 cfg_options.extend(target_cfgs.iter().chain(krate.cfg.iter()).cloned());
332
333 Some((
334 crate_id,
335 crate_graph.add_crate_root(
336 file_id,
337 krate.edition,
338 krate.display_name.clone(),
339 cfg_options,
340 env,
341 proc_macro.unwrap_or_default(),
342 ),
343 ))
344 })
345 .collect();
346
347 for (from, krate) in project.crates() {
348 if let Some(&from) = crates.get(&from) {
349 if let Some((public_deps, _proc_macro)) = &sysroot_dps {
350 for (name, to) in public_deps.iter() {
351 if let Err(_) = crate_graph.add_dep(from, name.clone(), *to) {
352 log::error!("cyclic dependency on {} for {:?}", name, from)
353 }
354 }
355 }
356
357 for dep in &krate.deps {
358 let to_crate_id = dep.crate_id;
359 if let Some(&to) = crates.get(&to_crate_id) {
360 if let Err(_) = crate_graph.add_dep(from, dep.name.clone(), to) {
361 log::error!("cyclic dependency {:?} -> {:?}", from, to);
362 }
363 }
364 }
365 }
366 }
367 }
368 ProjectWorkspace::Cargo { cargo, sysroot } => {
369 let (public_deps, libproc_macro) =
370 sysroot_to_crate_graph(&mut crate_graph, sysroot, target, load);
371
372 let mut cfg_options = CfgOptions::default();
373 cfg_options.extend(get_rustc_cfg_options(target));
374
375 let mut pkg_to_lib_crate = FxHashMap::default();
376 let mut pkg_crates = FxHashMap::default();
377
378 // Add test cfg for non-sysroot crates
379 cfg_options.insert_atom("test".into());
380 cfg_options.insert_atom("debug_assertions".into());
381
382 // Next, create crates for each package, target pair
383 for pkg in cargo.packages() {
384 let mut lib_tgt = None;
385 for &tgt in cargo[pkg].targets.iter() {
386 let root = cargo[tgt].root.as_path();
387 if let Some(file_id) = load(root) {
388 let edition = cargo[pkg].edition;
389 let cfg_options = {
390 let mut opts = cfg_options.clone();
391 for feature in cargo[pkg].features.iter() {
392 opts.insert_key_value("feature".into(), feature.into());
393 }
394 opts.extend(cargo[pkg].cfgs.iter().cloned());
395 opts
396 };
397 let mut env = Env::default();
398 if let Some(out_dir) = &cargo[pkg].out_dir {
399 // NOTE: cargo and rustc seem to hide non-UTF-8 strings from env! and option_env!()
400 if let Some(out_dir) = out_dir.to_str().map(|s| s.to_owned()) {
401 env.set("OUT_DIR", out_dir);
402 }
403 }
404 let proc_macro = cargo[pkg]
405 .proc_macro_dylib_path
406 .as_ref()
407 .map(|it| proc_macro_client.by_dylib_path(&it))
408 .unwrap_or_default();
409
410 let display_name =
411 CrateDisplayName::from_canonical_name(cargo[pkg].name.clone());
412 let crate_id = crate_graph.add_crate_root(
413 file_id,
414 edition,
415 Some(display_name),
416 cfg_options,
417 env,
418 proc_macro.clone(),
419 );
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);
423 }
424 if cargo[tgt].is_proc_macro {
425 if let Some(proc_macro) = libproc_macro {
426 if let Err(_) = crate_graph.add_dep(
427 crate_id,
428 CrateName::new("proc_macro").unwrap(),
429 proc_macro,
430 ) {
431 log::error!(
432 "cyclic dependency on proc_macro for {}",
433 &cargo[pkg].name
434 )
435 }
436 }
437 }
438
439 pkg_crates.entry(pkg).or_insert_with(Vec::new).push(crate_id);
440 }
441 }
442
443 // Set deps to the core, std and to the lib target of the current package
444 for &from in pkg_crates.get(&pkg).into_iter().flatten() {
445 if let Some((to, name)) = lib_tgt.clone() {
446 // For root projects with dashes in their name,
447 // cargo metadata does not do any normalization,
448 // so we do it ourselves currently
449 let name = CrateName::normalize_dashes(&name);
450 if to != from && crate_graph.add_dep(from, name, to).is_err() {
451 log::error!(
452 "cyclic dependency between targets of {}",
453 &cargo[pkg].name
454 )
455 }
456 }
457 for (name, krate) in public_deps.iter() {
458 if let Err(_) = crate_graph.add_dep(from, name.clone(), *krate) {
459 log::error!(
460 "cyclic dependency on {} for {}",
461 name,
462 &cargo[pkg].name
463 )
464 }
465 }
466 }
467 }
468
469 // Now add a dep edge from all targets of upstream to the lib
470 // target of downstream.
471 for pkg in cargo.packages() {
472 for dep in cargo[pkg].dependencies.iter() {
473 let name = CrateName::new(&dep.name).unwrap();
474 if let Some(&to) = pkg_to_lib_crate.get(&dep.pkg) {
475 for &from in pkg_crates.get(&pkg).into_iter().flatten() {
476 if let Err(_) = crate_graph.add_dep(from, name.clone(), to) {
477 log::error!(
478 "cyclic dependency {} -> {}",
479 &cargo[pkg].name,
480 &cargo[dep.pkg].name
481 )
482 }
483 }
484 }
485 }
486 }
487 }
488 }
489 if crate_graph.patch_cfg_if() {
490 log::debug!("Patched std to depend on cfg-if")
491 } else {
492 log::debug!("Did not patch std to depend on cfg-if")
493 }
494 crate_graph
495 }
496}
497
498fn get_rustc_cfg_options(target: Option<&str>) -> Vec<CfgFlag> {
499 let mut res = Vec::new();
500
501 // Some nightly-only cfgs, which are required for stdlib
502 res.push(CfgFlag::Atom("target_thread_local".into()));
503 for &ty in ["8", "16", "32", "64", "cas", "ptr"].iter() {
504 for &key in ["target_has_atomic", "target_has_atomic_load_store"].iter() {
505 res.push(CfgFlag::KeyValue { key: key.to_string(), value: ty.into() });
506 }
507 }
508
509 let rustc_cfgs = {
510 let mut cmd = Command::new(toolchain::rustc());
511 cmd.args(&["--print", "cfg", "-O"]);
512 if let Some(target) = target {
513 cmd.args(&["--target", target]);
514 }
515 utf8_stdout(cmd)
516 };
517
518 match rustc_cfgs {
519 Ok(rustc_cfgs) => res.extend(rustc_cfgs.lines().map(|it| it.parse().unwrap())),
520 Err(e) => log::error!("failed to get rustc cfgs: {:#}", e),
521 }
522
523 res
524}
525
526fn utf8_stdout(mut cmd: Command) -> Result<String> { 114fn utf8_stdout(mut cmd: Command) -> Result<String> {
527 let output = cmd.output().with_context(|| format!("{:?} failed", cmd))?; 115 let output = cmd.output().with_context(|| format!("{:?} failed", cmd))?;
528 if !output.status.success() { 116 if !output.status.success() {
@@ -536,52 +124,3 @@ fn utf8_stdout(mut cmd: Command) -> Result<String> {
536 let stdout = String::from_utf8(output.stdout)?; 124 let stdout = String::from_utf8(output.stdout)?;
537 Ok(stdout.trim().to_string()) 125 Ok(stdout.trim().to_string())
538} 126}
539
540fn sysroot_to_crate_graph(
541 crate_graph: &mut CrateGraph,
542 sysroot: &Sysroot,
543 target: Option<&str>,
544 load: &mut dyn FnMut(&AbsPath) -> Option<FileId>,
545) -> (Vec<(CrateName, CrateId)>, Option<CrateId>) {
546 let mut cfg_options = CfgOptions::default();
547 cfg_options.extend(get_rustc_cfg_options(target));
548 let sysroot_crates: FxHashMap<_, _> = sysroot
549 .crates()
550 .filter_map(|krate| {
551 let file_id = load(&sysroot[krate].root)?;
552
553 let env = Env::default();
554 let proc_macro = vec![];
555 let name = CrateName::new(&sysroot[krate].name)
556 .expect("Sysroot crates' names do not contain dashes");
557 let crate_id = crate_graph.add_crate_root(
558 file_id,
559 Edition::Edition2018,
560 Some(name.into()),
561 cfg_options.clone(),
562 env,
563 proc_macro,
564 );
565 Some((krate, crate_id))
566 })
567 .collect();
568
569 for from in sysroot.crates() {
570 for &to in sysroot[from].deps.iter() {
571 let name = CrateName::new(&sysroot[to].name).unwrap();
572 if let (Some(&from), Some(&to)) = (sysroot_crates.get(&from), sysroot_crates.get(&to)) {
573 if let Err(_) = crate_graph.add_dep(from, name, to) {
574 log::error!("cyclic dependency between sysroot crates")
575 }
576 }
577 }
578 }
579
580 let public_deps = sysroot
581 .public_deps()
582 .map(|(name, idx)| (CrateName::new(name).unwrap(), sysroot_crates[&idx]))
583 .collect::<Vec<_>>();
584
585 let libproc_macro = sysroot.proc_macro().and_then(|it| sysroot_crates.get(&it).copied());
586 (public_deps, libproc_macro)
587}
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-03 03:41:05 +0000