Module cargo_compile

The entry point for starting the compilation process for commands like build, test, doc, rustc, etc.

The compile function will do all the work to compile a workspace. A rough outline is:

1. Resolve the dependency graph (see ops::resolve).
2. Download any packages needed (see PackageSet).
3. Generate a list of top-level “units” of work for the targets the user requested on the command-line. Each Unit corresponds to a compiler invocation. This is done in this module (UnitGenerator::generate_root_units).
4. Starting from the root Units, generate the UnitGraph by walking the dependency graph from the resolver. See also unit_dependencies.
5. Construct the BuildContext with all of the information collected so far. This is the end of the “front end” of compilation.
6. Create a BuildRunner which coordinates the compilation process and will perform the following steps:
   1. Prepare the target directory (see Layout).
   2. Create a JobQueue. The queue checks the fingerprint of each Unit to determine if it should run or be skipped.
   3. Execute the queue via drain_the_queue. Each leaf in the queue’s dependency graph is executed, and then removed from the graph when finished. This repeats until the queue is empty. Note that this is the only point in cargo that currently uses threads.
7. The result of the compilation is stored in the Compilation struct. This can be used for various things, such as running tests after the compilation has finished.

Note: “target” inside this module generally refers to “Cargo Target”, which corresponds to artifact that will be built in a package. Not to be confused with target-triple or target architecture.

Re-exports

pub use compile_filter::CompileFilter;

pub use compile_filter::FilterRule;

pub use compile_filter::LibRule;

pub use packages::Packages;

Modules

compile_filter 🔒

Filters and their rules to select which Cargo targets will be built.

packages 🔒

See Packages.

unit_generator 🔒

Structs

CompileOptions

Contains information about how a package should be compiled.

Functions

compile

Compiles!

compile_with_exec

Like compile but allows specifying a custom Executor that will be able to intercept build calls and add custom logic.

compile_ws

Like compile_with_exec but without warnings from manifest parsing.

create_bcx

Prepares all required information for the actual compilation.

override_rustc_crate_types 🔒

Override crate types for given units.

print

Executes rustc --print <VALUE>.

rebuild_unit_graph_shared 🔒

This is used to rebuild the unit graph, sharing host dependencies if possible, and applying other unit adjustments based on the whole graph.

remove_duplicate_doc 🔒

Removes duplicate CompileMode::Doc units that would cause problems with filename collisions.

resolve_all_features

Gets all of the features enabled for a package, plus its dependencies’ features.

traverse_and_share 🔒

Recursive function for rebuilding the graph.