1 //! Constructs the dependency graph for compilation.
2 //!
3 //! Rust code is typically organized as a set of Cargo packages. The
4 //! dependencies between the packages themselves are stored in the
5 //! `Resolve` struct. However, we can't use that information as is for
6 //! compilation! A package typically contains several targets, or crates,
7 //! and these targets has inter-dependencies. For example, you need to
8 //! compile the `lib` target before the `bin` one, and you need to compile
9 //! `build.rs` before either of those.
10 //!
11 //! So, we need to lower the `Resolve`, which specifies dependencies between
12 //! *packages*, to a graph of dependencies between their *targets*, and this
13 //! is exactly what this module is doing! Well, almost exactly: another
14 //! complication is that we might want to compile the same target several times
15 //! (for example, with and without tests), so we actually build a dependency
16 //! graph of `Unit`s, which capture these properties.
17 
18 use crate::core::compiler::unit_graph::{UnitDep, UnitGraph};
19 use crate::core::compiler::UnitInterner;
20 use crate::core::compiler::{CompileKind, CompileMode, RustcTargetData, Unit};
21 use crate::core::dependency::DepKind;
22 use crate::core::profiles::{Profile, Profiles, UnitFor};
23 use crate::core::resolver::features::{FeaturesFor, ResolvedFeatures};
24 use crate::core::resolver::Resolve;
25 use crate::core::{Dependency, Package, PackageId, PackageSet, Target, Workspace};
26 use crate::ops::resolve_all_features;
27 use crate::util::interning::InternedString;
28 use crate::util::Config;
29 use crate::CargoResult;
30 use log::trace;
31 use std::collections::{HashMap, HashSet};
32 
33 /// Collection of stuff used while creating the `UnitGraph`.
34 struct State<'a, 'cfg> {
35     ws: &'a Workspace<'cfg>,
36     config: &'cfg Config,
37     unit_dependencies: UnitGraph,
38     package_set: &'a PackageSet<'cfg>,
39     usr_resolve: &'a Resolve,
40     usr_features: &'a ResolvedFeatures,
41     std_resolve: Option<&'a Resolve>,
42     std_features: Option<&'a ResolvedFeatures>,
43     /// This flag is `true` while generating the dependencies for the standard
44     /// library.
45     is_std: bool,
46     global_mode: CompileMode,
47     target_data: &'a RustcTargetData<'cfg>,
48     profiles: &'a Profiles,
49     interner: &'a UnitInterner,
50 
51     /// A set of edges in `unit_dependencies` where (a, b) means that the
52     /// dependency from a to b was added purely because it was a dev-dependency.
53     /// This is used during `connect_run_custom_build_deps`.
54     dev_dependency_edges: HashSet<(Unit, Unit)>,
55 }
56 
build_unit_dependencies<'a, 'cfg>( ws: &'a Workspace<'cfg>, package_set: &'a PackageSet<'cfg>, resolve: &'a Resolve, features: &'a ResolvedFeatures, std_resolve: Option<&'a (Resolve, ResolvedFeatures)>, roots: &[Unit], std_roots: &HashMap<CompileKind, Vec<Unit>>, global_mode: CompileMode, target_data: &'a RustcTargetData<'cfg>, profiles: &'a Profiles, interner: &'a UnitInterner, ) -> CargoResult<UnitGraph>57 pub fn build_unit_dependencies<'a, 'cfg>(
58     ws: &'a Workspace<'cfg>,
59     package_set: &'a PackageSet<'cfg>,
60     resolve: &'a Resolve,
61     features: &'a ResolvedFeatures,
62     std_resolve: Option<&'a (Resolve, ResolvedFeatures)>,
63     roots: &[Unit],
64     std_roots: &HashMap<CompileKind, Vec<Unit>>,
65     global_mode: CompileMode,
66     target_data: &'a RustcTargetData<'cfg>,
67     profiles: &'a Profiles,
68     interner: &'a UnitInterner,
69 ) -> CargoResult<UnitGraph> {
70     if roots.is_empty() {
71         // If -Zbuild-std, don't attach units if there is nothing to build.
72         // Otherwise, other parts of the code may be confused by seeing units
73         // in the dep graph without a root.
74         return Ok(HashMap::new());
75     }
76     let (std_resolve, std_features) = match std_resolve {
77         Some((r, f)) => (Some(r), Some(f)),
78         None => (None, None),
79     };
80     let mut state = State {
81         ws,
82         config: ws.config(),
83         unit_dependencies: HashMap::new(),
84         package_set,
85         usr_resolve: resolve,
86         usr_features: features,
87         std_resolve,
88         std_features,
89         is_std: false,
90         global_mode,
91         target_data,
92         profiles,
93         interner,
94         dev_dependency_edges: HashSet::new(),
95     };
96 
97     let std_unit_deps = calc_deps_of_std(&mut state, std_roots)?;
98 
99     deps_of_roots(roots, &mut state)?;
100     super::links::validate_links(state.resolve(), &state.unit_dependencies)?;
101     // Hopefully there aren't any links conflicts with the standard library?
102 
103     if let Some(std_unit_deps) = std_unit_deps {
104         attach_std_deps(&mut state, std_roots, std_unit_deps);
105     }
106 
107     connect_run_custom_build_deps(&mut state);
108 
109     // Dependencies are used in tons of places throughout the backend, many of
110     // which affect the determinism of the build itself. As a result be sure
111     // that dependency lists are always sorted to ensure we've always got a
112     // deterministic output.
113     for list in state.unit_dependencies.values_mut() {
114         list.sort();
115     }
116     trace!("ALL UNIT DEPENDENCIES {:#?}", state.unit_dependencies);
117 
118     Ok(state.unit_dependencies)
119 }
120 
121 /// Compute all the dependencies for the standard library.
calc_deps_of_std( mut state: &mut State<'_, '_>, std_roots: &HashMap<CompileKind, Vec<Unit>>, ) -> CargoResult<Option<UnitGraph>>122 fn calc_deps_of_std(
123     mut state: &mut State<'_, '_>,
124     std_roots: &HashMap<CompileKind, Vec<Unit>>,
125 ) -> CargoResult<Option<UnitGraph>> {
126     if std_roots.is_empty() {
127         return Ok(None);
128     }
129     // Compute dependencies for the standard library.
130     state.is_std = true;
131     for roots in std_roots.values() {
132         deps_of_roots(roots, &mut state)?;
133     }
134     state.is_std = false;
135     Ok(Some(std::mem::take(&mut state.unit_dependencies)))
136 }
137 
138 /// Add the standard library units to the `unit_dependencies`.
attach_std_deps( state: &mut State<'_, '_>, std_roots: &HashMap<CompileKind, Vec<Unit>>, std_unit_deps: UnitGraph, )139 fn attach_std_deps(
140     state: &mut State<'_, '_>,
141     std_roots: &HashMap<CompileKind, Vec<Unit>>,
142     std_unit_deps: UnitGraph,
143 ) {
144     // Attach the standard library as a dependency of every target unit.
145     for (unit, deps) in state.unit_dependencies.iter_mut() {
146         if !unit.kind.is_host() && !unit.mode.is_run_custom_build() {
147             deps.extend(std_roots[&unit.kind].iter().map(|unit| UnitDep {
148                 unit: unit.clone(),
149                 unit_for: UnitFor::new_normal(),
150                 extern_crate_name: unit.pkg.name(),
151                 // TODO: Does this `public` make sense?
152                 public: true,
153                 noprelude: true,
154             }));
155         }
156     }
157     // And also include the dependencies of the standard library itself.
158     for (unit, deps) in std_unit_deps.into_iter() {
159         if let Some(other_unit) = state.unit_dependencies.insert(unit, deps) {
160             panic!("std unit collision with existing unit: {:?}", other_unit);
161         }
162     }
163 }
164 
165 /// Compute all the dependencies of the given root units.
166 /// The result is stored in state.unit_dependencies.
deps_of_roots(roots: &[Unit], mut state: &mut State<'_, '_>) -> CargoResult<()>167 fn deps_of_roots(roots: &[Unit], mut state: &mut State<'_, '_>) -> CargoResult<()> {
168     for unit in roots.iter() {
169         // Dependencies of tests/benches should not have `panic` set.
170         // We check the global test mode to see if we are running in `cargo
171         // test` in which case we ensure all dependencies have `panic`
172         // cleared, and avoid building the lib thrice (once with `panic`, once
173         // without, once for `--test`). In particular, the lib included for
174         // Doc tests and examples are `Build` mode here.
175         let unit_for = if unit.mode.is_any_test() || state.global_mode.is_rustc_test() {
176             if unit.target.proc_macro() {
177                 // Special-case for proc-macros, which are forced to for-host
178                 // since they need to link with the proc_macro crate.
179                 UnitFor::new_host_test(state.config)
180             } else {
181                 UnitFor::new_test(state.config)
182             }
183         } else if unit.target.is_custom_build() {
184             // This normally doesn't happen, except `clean` aggressively
185             // generates all units.
186             UnitFor::new_host(false)
187         } else if unit.target.proc_macro() {
188             UnitFor::new_host(true)
189         } else if unit.target.for_host() {
190             // Plugin should never have panic set.
191             UnitFor::new_compiler()
192         } else {
193             UnitFor::new_normal()
194         };
195         deps_of(unit, &mut state, unit_for)?;
196     }
197 
198     Ok(())
199 }
200 
201 /// Compute the dependencies of a single unit.
deps_of(unit: &Unit, state: &mut State<'_, '_>, unit_for: UnitFor) -> CargoResult<()>202 fn deps_of(unit: &Unit, state: &mut State<'_, '_>, unit_for: UnitFor) -> CargoResult<()> {
203     // Currently the `unit_dependencies` map does not include `unit_for`. This should
204     // be safe for now. `TestDependency` only exists to clear the `panic`
205     // flag, and you'll never ask for a `unit` with `panic` set as a
206     // `TestDependency`. `CustomBuild` should also be fine since if the
207     // requested unit's settings are the same as `Any`, `CustomBuild` can't
208     // affect anything else in the hierarchy.
209     if !state.unit_dependencies.contains_key(unit) {
210         let unit_deps = compute_deps(unit, state, unit_for)?;
211         state
212             .unit_dependencies
213             .insert(unit.clone(), unit_deps.clone());
214         for unit_dep in unit_deps {
215             deps_of(&unit_dep.unit, state, unit_dep.unit_for)?;
216         }
217     }
218     Ok(())
219 }
220 
221 /// For a package, returns all targets that are registered as dependencies
222 /// for that package.
223 /// This returns a `Vec` of `(Unit, UnitFor)` pairs. The `UnitFor`
224 /// is the profile type that should be used for dependencies of the unit.
compute_deps( unit: &Unit, state: &mut State<'_, '_>, unit_for: UnitFor, ) -> CargoResult<Vec<UnitDep>>225 fn compute_deps(
226     unit: &Unit,
227     state: &mut State<'_, '_>,
228     unit_for: UnitFor,
229 ) -> CargoResult<Vec<UnitDep>> {
230     if unit.mode.is_run_custom_build() {
231         return compute_deps_custom_build(unit, unit_for, state);
232     } else if unit.mode.is_doc() {
233         // Note: this does not include doc test.
234         return compute_deps_doc(unit, state, unit_for);
235     }
236 
237     let id = unit.pkg.package_id();
238     let filtered_deps = state.deps(unit, unit_for, &|dep| {
239         // If this target is a build command, then we only want build
240         // dependencies, otherwise we want everything *other than* build
241         // dependencies.
242         if unit.target.is_custom_build() != dep.is_build() {
243             return false;
244         }
245 
246         // If this dependency is **not** a transitive dependency, then it
247         // only applies to test/example targets.
248         if !dep.is_transitive()
249             && !unit.target.is_test()
250             && !unit.target.is_example()
251             && !unit.mode.is_any_test()
252         {
253             return false;
254         }
255 
256         // If we've gotten past all that, then this dependency is
257         // actually used!
258         true
259     });
260 
261     let mut ret = Vec::new();
262     let mut dev_deps = Vec::new();
263     for (id, deps) in filtered_deps {
264         let pkg = state.get(id);
265         let lib = match pkg.targets().iter().find(|t| t.is_lib()) {
266             Some(t) => t,
267             None => continue,
268         };
269         let mode = check_or_build_mode(unit.mode, lib);
270         let dep_unit_for = unit_for.with_dependency(unit, lib);
271 
272         let start = ret.len();
273         if state.config.cli_unstable().dual_proc_macros && lib.proc_macro() && !unit.kind.is_host()
274         {
275             let unit_dep = new_unit_dep(state, unit, pkg, lib, dep_unit_for, unit.kind, mode)?;
276             ret.push(unit_dep);
277             let unit_dep =
278                 new_unit_dep(state, unit, pkg, lib, dep_unit_for, CompileKind::Host, mode)?;
279             ret.push(unit_dep);
280         } else {
281             let unit_dep = new_unit_dep(
282                 state,
283                 unit,
284                 pkg,
285                 lib,
286                 dep_unit_for,
287                 unit.kind.for_target(lib),
288                 mode,
289             )?;
290             ret.push(unit_dep);
291         }
292 
293         // If the unit added was a dev-dependency unit, then record that in the
294         // dev-dependencies array. We'll add this to
295         // `state.dev_dependency_edges` at the end and process it later in
296         // `connect_run_custom_build_deps`.
297         if deps.iter().all(|d| !d.is_transitive()) {
298             for dep in ret[start..].iter() {
299                 dev_deps.push((unit.clone(), dep.unit.clone()));
300             }
301         }
302     }
303     state.dev_dependency_edges.extend(dev_deps);
304 
305     // If this target is a build script, then what we've collected so far is
306     // all we need. If this isn't a build script, then it depends on the
307     // build script if there is one.
308     if unit.target.is_custom_build() {
309         return Ok(ret);
310     }
311     ret.extend(dep_build_script(unit, unit_for, state)?);
312 
313     // If this target is a binary, test, example, etc, then it depends on
314     // the library of the same package. The call to `resolve.deps` above
315     // didn't include `pkg` in the return values, so we need to special case
316     // it here and see if we need to push `(pkg, pkg_lib_target)`.
317     if unit.target.is_lib() && unit.mode != CompileMode::Doctest {
318         return Ok(ret);
319     }
320     ret.extend(maybe_lib(unit, state, unit_for)?);
321 
322     // If any integration tests/benches are being run, make sure that
323     // binaries are built as well.
324     if !unit.mode.is_check()
325         && unit.mode.is_any_test()
326         && (unit.target.is_test() || unit.target.is_bench())
327     {
328         ret.extend(
329             unit.pkg
330                 .targets()
331                 .iter()
332                 .filter(|t| {
333                     // Skip binaries with required features that have not been selected.
334                     match t.required_features() {
335                         Some(rf) if t.is_bin() => {
336                             let features = resolve_all_features(
337                                 state.resolve(),
338                                 state.features(),
339                                 state.package_set,
340                                 id,
341                             );
342                             rf.iter().all(|f| features.contains(f))
343                         }
344                         None if t.is_bin() => true,
345                         _ => false,
346                     }
347                 })
348                 .map(|t| {
349                     new_unit_dep(
350                         state,
351                         unit,
352                         &unit.pkg,
353                         t,
354                         UnitFor::new_normal(),
355                         unit.kind.for_target(t),
356                         CompileMode::Build,
357                     )
358                 })
359                 .collect::<CargoResult<Vec<UnitDep>>>()?,
360         );
361     }
362 
363     Ok(ret)
364 }
365 
366 /// Returns the dependencies needed to run a build script.
367 ///
368 /// The `unit` provided must represent an execution of a build script, and
369 /// the returned set of units must all be run before `unit` is run.
compute_deps_custom_build( unit: &Unit, unit_for: UnitFor, state: &mut State<'_, '_>, ) -> CargoResult<Vec<UnitDep>>370 fn compute_deps_custom_build(
371     unit: &Unit,
372     unit_for: UnitFor,
373     state: &mut State<'_, '_>,
374 ) -> CargoResult<Vec<UnitDep>> {
375     if let Some(links) = unit.pkg.manifest().links() {
376         if state
377             .target_data
378             .script_override(links, unit.kind)
379             .is_some()
380         {
381             // Overridden build scripts don't have any dependencies.
382             return Ok(Vec::new());
383         }
384     }
385     // All dependencies of this unit should use profiles for custom builds.
386     // If this is a build script of a proc macro, make sure it uses host
387     // features.
388     let script_unit_for = UnitFor::new_host(unit_for.is_for_host_features());
389     // When not overridden, then the dependencies to run a build script are:
390     //
391     // 1. Compiling the build script itself.
392     // 2. For each immediate dependency of our package which has a `links`
393     //    key, the execution of that build script.
394     //
395     // We don't have a great way of handling (2) here right now so this is
396     // deferred until after the graph of all unit dependencies has been
397     // constructed.
398     let unit_dep = new_unit_dep(
399         state,
400         unit,
401         &unit.pkg,
402         &unit.target,
403         script_unit_for,
404         // Build scripts always compiled for the host.
405         CompileKind::Host,
406         CompileMode::Build,
407     )?;
408     Ok(vec![unit_dep])
409 }
410 
411 /// Returns the dependencies necessary to document a package.
compute_deps_doc( unit: &Unit, state: &mut State<'_, '_>, unit_for: UnitFor, ) -> CargoResult<Vec<UnitDep>>412 fn compute_deps_doc(
413     unit: &Unit,
414     state: &mut State<'_, '_>,
415     unit_for: UnitFor,
416 ) -> CargoResult<Vec<UnitDep>> {
417     let deps = state.deps(unit, unit_for, &|dep| dep.kind() == DepKind::Normal);
418 
419     // To document a library, we depend on dependencies actually being
420     // built. If we're documenting *all* libraries, then we also depend on
421     // the documentation of the library being built.
422     let mut ret = Vec::new();
423     for (id, _deps) in deps {
424         let dep = state.get(id);
425         let lib = match dep.targets().iter().find(|t| t.is_lib()) {
426             Some(lib) => lib,
427             None => continue,
428         };
429         // Rustdoc only needs rmeta files for regular dependencies.
430         // However, for plugins/proc macros, deps should be built like normal.
431         let mode = check_or_build_mode(unit.mode, lib);
432         let dep_unit_for = unit_for.with_dependency(unit, lib);
433         let lib_unit_dep = new_unit_dep(
434             state,
435             unit,
436             dep,
437             lib,
438             dep_unit_for,
439             unit.kind.for_target(lib),
440             mode,
441         )?;
442         ret.push(lib_unit_dep);
443         if let CompileMode::Doc { deps: true } = unit.mode {
444             // Document this lib as well.
445             let doc_unit_dep = new_unit_dep(
446                 state,
447                 unit,
448                 dep,
449                 lib,
450                 dep_unit_for,
451                 unit.kind.for_target(lib),
452                 unit.mode,
453             )?;
454             ret.push(doc_unit_dep);
455         }
456     }
457 
458     // Be sure to build/run the build script for documented libraries.
459     ret.extend(dep_build_script(unit, unit_for, state)?);
460 
461     // If we document a binary/example, we need the library available.
462     if unit.target.is_bin() || unit.target.is_example() {
463         ret.extend(maybe_lib(unit, state, unit_for)?);
464     }
465     Ok(ret)
466 }
467 
maybe_lib( unit: &Unit, state: &mut State<'_, '_>, unit_for: UnitFor, ) -> CargoResult<Option<UnitDep>>468 fn maybe_lib(
469     unit: &Unit,
470     state: &mut State<'_, '_>,
471     unit_for: UnitFor,
472 ) -> CargoResult<Option<UnitDep>> {
473     unit.pkg
474         .targets()
475         .iter()
476         .find(|t| t.is_linkable())
477         .map(|t| {
478             let mode = check_or_build_mode(unit.mode, t);
479             let dep_unit_for = unit_for.with_dependency(unit, t);
480             new_unit_dep(
481                 state,
482                 unit,
483                 &unit.pkg,
484                 t,
485                 dep_unit_for,
486                 unit.kind.for_target(t),
487                 mode,
488             )
489         })
490         .transpose()
491 }
492 
493 /// If a build script is scheduled to be run for the package specified by
494 /// `unit`, this function will return the unit to run that build script.
495 ///
496 /// Overriding a build script simply means that the running of the build
497 /// script itself doesn't have any dependencies, so even in that case a unit
498 /// of work is still returned. `None` is only returned if the package has no
499 /// build script.
dep_build_script( unit: &Unit, unit_for: UnitFor, state: &State<'_, '_>, ) -> CargoResult<Option<UnitDep>>500 fn dep_build_script(
501     unit: &Unit,
502     unit_for: UnitFor,
503     state: &State<'_, '_>,
504 ) -> CargoResult<Option<UnitDep>> {
505     unit.pkg
506         .targets()
507         .iter()
508         .find(|t| t.is_custom_build())
509         .map(|t| {
510             // The profile stored in the Unit is the profile for the thing
511             // the custom build script is running for.
512             let profile = state.profiles.get_profile_run_custom_build(&unit.profile);
513             // UnitFor::new_host is used because we want the `host` flag set
514             // for all of our build dependencies (so they all get
515             // build-override profiles), including compiling the build.rs
516             // script itself.
517             //
518             // If `is_for_host_features` here is `false`, that means we are a
519             // build.rs script for a normal dependency and we want to set the
520             // CARGO_FEATURE_* environment variables to the features as a
521             // normal dep.
522             //
523             // If `is_for_host_features` here is `true`, that means that this
524             // package is being used as a build dependency or proc-macro, and
525             // so we only want to set CARGO_FEATURE_* variables for the host
526             // side of the graph.
527             //
528             // Keep in mind that the RunCustomBuild unit and the Compile
529             // build.rs unit use the same features. This is because some
530             // people use `cfg!` and `#[cfg]` expressions to check for enabled
531             // features instead of just checking `CARGO_FEATURE_*` at runtime.
532             // In the case with the new feature resolver (decoupled host
533             // deps), and a shared dependency has different features enabled
534             // for normal vs. build, then the build.rs script will get
535             // compiled twice. I believe it is not feasible to only build it
536             // once because it would break a large number of scripts (they
537             // would think they have the wrong set of features enabled).
538             let script_unit_for = UnitFor::new_host(unit_for.is_for_host_features());
539             new_unit_dep_with_profile(
540                 state,
541                 unit,
542                 &unit.pkg,
543                 t,
544                 script_unit_for,
545                 unit.kind,
546                 CompileMode::RunCustomBuild,
547                 profile,
548             )
549         })
550         .transpose()
551 }
552 
553 /// Choose the correct mode for dependencies.
check_or_build_mode(mode: CompileMode, target: &Target) -> CompileMode554 fn check_or_build_mode(mode: CompileMode, target: &Target) -> CompileMode {
555     match mode {
556         CompileMode::Check { .. } | CompileMode::Doc { .. } => {
557             if target.for_host() {
558                 // Plugin and proc macro targets should be compiled like
559                 // normal.
560                 CompileMode::Build
561             } else {
562                 // Regular dependencies should not be checked with --test.
563                 // Regular dependencies of doc targets should emit rmeta only.
564                 CompileMode::Check { test: false }
565             }
566         }
567         _ => CompileMode::Build,
568     }
569 }
570 
571 /// Create a new Unit for a dependency from `parent` to `pkg` and `target`.
new_unit_dep( state: &State<'_, '_>, parent: &Unit, pkg: &Package, target: &Target, unit_for: UnitFor, kind: CompileKind, mode: CompileMode, ) -> CargoResult<UnitDep>572 fn new_unit_dep(
573     state: &State<'_, '_>,
574     parent: &Unit,
575     pkg: &Package,
576     target: &Target,
577     unit_for: UnitFor,
578     kind: CompileKind,
579     mode: CompileMode,
580 ) -> CargoResult<UnitDep> {
581     let is_local = pkg.package_id().source_id().is_path() && !state.is_std;
582     let profile = state.profiles.get_profile(
583         pkg.package_id(),
584         state.ws.is_member(pkg),
585         is_local,
586         unit_for,
587         mode,
588         kind,
589     );
590     new_unit_dep_with_profile(state, parent, pkg, target, unit_for, kind, mode, profile)
591 }
592 
new_unit_dep_with_profile( state: &State<'_, '_>, parent: &Unit, pkg: &Package, target: &Target, unit_for: UnitFor, kind: CompileKind, mode: CompileMode, profile: Profile, ) -> CargoResult<UnitDep>593 fn new_unit_dep_with_profile(
594     state: &State<'_, '_>,
595     parent: &Unit,
596     pkg: &Package,
597     target: &Target,
598     unit_for: UnitFor,
599     kind: CompileKind,
600     mode: CompileMode,
601     profile: Profile,
602 ) -> CargoResult<UnitDep> {
603     // TODO: consider making extern_crate_name return InternedString?
604     let extern_crate_name = InternedString::new(&state.resolve().extern_crate_name(
605         parent.pkg.package_id(),
606         pkg.package_id(),
607         target,
608     )?);
609     let public = state
610         .resolve()
611         .is_public_dep(parent.pkg.package_id(), pkg.package_id());
612     let features_for = unit_for.map_to_features_for();
613     let features = state.activated_features(pkg.package_id(), features_for);
614     let unit = state
615         .interner
616         .intern(pkg, target, profile, kind, mode, features, state.is_std, 0);
617     Ok(UnitDep {
618         unit,
619         unit_for,
620         extern_crate_name,
621         public,
622         noprelude: false,
623     })
624 }
625 
626 /// Fill in missing dependencies for units of the `RunCustomBuild`
627 ///
628 /// As mentioned above in `compute_deps_custom_build` each build script
629 /// execution has two dependencies. The first is compiling the build script
630 /// itself (already added) and the second is that all crates the package of the
631 /// build script depends on with `links` keys, their build script execution. (a
632 /// bit confusing eh?)
633 ///
634 /// Here we take the entire `deps` map and add more dependencies from execution
635 /// of one build script to execution of another build script.
connect_run_custom_build_deps(state: &mut State<'_, '_>)636 fn connect_run_custom_build_deps(state: &mut State<'_, '_>) {
637     let mut new_deps = Vec::new();
638 
639     {
640         let state = &*state;
641         // First up build a reverse dependency map. This is a mapping of all
642         // `RunCustomBuild` known steps to the unit which depends on them. For
643         // example a library might depend on a build script, so this map will
644         // have the build script as the key and the library would be in the
645         // value's set.
646         let mut reverse_deps_map = HashMap::new();
647         for (unit, deps) in state.unit_dependencies.iter() {
648             for dep in deps {
649                 if dep.unit.mode == CompileMode::RunCustomBuild {
650                     reverse_deps_map
651                         .entry(dep.unit.clone())
652                         .or_insert_with(HashSet::new)
653                         .insert(unit);
654                 }
655             }
656         }
657 
658         // Next, we take a look at all build scripts executions listed in the
659         // dependency map. Our job here is to take everything that depends on
660         // this build script (from our reverse map above) and look at the other
661         // package dependencies of these parents.
662         //
663         // If we depend on a linkable target and the build script mentions
664         // `links`, then we depend on that package's build script! Here we use
665         // `dep_build_script` to manufacture an appropriate build script unit to
666         // depend on.
667         for unit in state
668             .unit_dependencies
669             .keys()
670             .filter(|k| k.mode == CompileMode::RunCustomBuild)
671         {
672             // This list of dependencies all depend on `unit`, an execution of
673             // the build script.
674             let reverse_deps = match reverse_deps_map.get(unit) {
675                 Some(set) => set,
676                 None => continue,
677             };
678 
679             let to_add = reverse_deps
680                 .iter()
681                 // Get all sibling dependencies of `unit`
682                 .flat_map(|reverse_dep| {
683                     state.unit_dependencies[reverse_dep]
684                         .iter()
685                         .map(move |a| (reverse_dep, a))
686                 })
687                 // Only deps with `links`.
688                 .filter(|(_parent, other)| {
689                     other.unit.pkg != unit.pkg
690                         && other.unit.target.is_linkable()
691                         && other.unit.pkg.manifest().links().is_some()
692                 })
693                 // Skip dependencies induced via dev-dependencies since
694                 // connections between `links` and build scripts only happens
695                 // via normal dependencies. Otherwise since dev-dependencies can
696                 // be cyclic we could have cyclic build-script executions.
697                 .filter_map(move |(parent, other)| {
698                     if state
699                         .dev_dependency_edges
700                         .contains(&((*parent).clone(), other.unit.clone()))
701                     {
702                         None
703                     } else {
704                         Some(other)
705                     }
706                 })
707                 // Get the RunCustomBuild for other lib.
708                 .filter_map(|other| {
709                     state.unit_dependencies[&other.unit]
710                         .iter()
711                         .find(|other_dep| other_dep.unit.mode == CompileMode::RunCustomBuild)
712                         .cloned()
713                 })
714                 .collect::<HashSet<_>>();
715 
716             if !to_add.is_empty() {
717                 // (RunCustomBuild, set(other RunCustomBuild))
718                 new_deps.push((unit.clone(), to_add));
719             }
720         }
721     }
722 
723     // And finally, add in all the missing dependencies!
724     for (unit, new_deps) in new_deps {
725         state
726             .unit_dependencies
727             .get_mut(&unit)
728             .unwrap()
729             .extend(new_deps);
730     }
731 }
732 
733 impl<'a, 'cfg> State<'a, 'cfg> {
resolve(&self) -> &'a Resolve734     fn resolve(&self) -> &'a Resolve {
735         if self.is_std {
736             self.std_resolve.unwrap()
737         } else {
738             self.usr_resolve
739         }
740     }
741 
features(&self) -> &'a ResolvedFeatures742     fn features(&self) -> &'a ResolvedFeatures {
743         if self.is_std {
744             self.std_features.unwrap()
745         } else {
746             self.usr_features
747         }
748     }
749 
activated_features( &self, pkg_id: PackageId, features_for: FeaturesFor, ) -> Vec<InternedString>750     fn activated_features(
751         &self,
752         pkg_id: PackageId,
753         features_for: FeaturesFor,
754     ) -> Vec<InternedString> {
755         let features = self.features();
756         features.activated_features(pkg_id, features_for)
757     }
758 
is_dep_activated( &self, pkg_id: PackageId, features_for: FeaturesFor, dep_name: InternedString, ) -> bool759     fn is_dep_activated(
760         &self,
761         pkg_id: PackageId,
762         features_for: FeaturesFor,
763         dep_name: InternedString,
764     ) -> bool {
765         self.features()
766             .is_dep_activated(pkg_id, features_for, dep_name)
767     }
768 
get(&self, id: PackageId) -> &'a Package769     fn get(&self, id: PackageId) -> &'a Package {
770         self.package_set
771             .get_one(id)
772             .unwrap_or_else(|_| panic!("expected {} to be downloaded", id))
773     }
774 
775     /// Returns a filtered set of dependencies for the given unit.
deps( &self, unit: &Unit, unit_for: UnitFor, filter: &dyn Fn(&Dependency) -> bool, ) -> Vec<(PackageId, &HashSet<Dependency>)>776     fn deps(
777         &self,
778         unit: &Unit,
779         unit_for: UnitFor,
780         filter: &dyn Fn(&Dependency) -> bool,
781     ) -> Vec<(PackageId, &HashSet<Dependency>)> {
782         let pkg_id = unit.pkg.package_id();
783         let kind = unit.kind;
784         self.resolve()
785             .deps(pkg_id)
786             .filter(|&(_id, deps)| {
787                 assert!(!deps.is_empty());
788                 deps.iter().any(|dep| {
789                     if !filter(dep) {
790                         return false;
791                     }
792                     // If this dependency is only available for certain platforms,
793                     // make sure we're only enabling it for that platform.
794                     if !self.target_data.dep_platform_activated(dep, kind) {
795                         return false;
796                     }
797 
798                     // If this is an optional dependency, and the new feature resolver
799                     // did not enable it, don't include it.
800                     if dep.is_optional() {
801                         let features_for = unit_for.map_to_features_for();
802                         if !self.is_dep_activated(pkg_id, features_for, dep.name_in_toml()) {
803                             return false;
804                         }
805                     }
806 
807                     true
808                 })
809             })
810             .collect()
811     }
812 }
813