Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle LTO with an rlib/cdylib crate type #8254

Merged
merged 1 commit into from
May 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 40 additions & 26 deletions src/cargo/core/compiler/lto.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
use crate::core::compiler::{Context, Unit};
use crate::core::interning::InternedString;
use crate::core::profiles;
use crate::core::TargetKind;
use crate::util::errors::CargoResult;
use std::collections::hash_map::{Entry, HashMap};

Expand All @@ -26,7 +27,7 @@ pub enum Lto {
pub fn generate(cx: &mut Context<'_, '_>) -> CargoResult<()> {
let mut map = HashMap::new();
for unit in cx.bcx.roots.iter() {
calculate(cx, &mut map, unit, false)?;
calculate(cx, &mut map, unit, Lto::None)?;
}
cx.lto = map;
Ok(())
Expand All @@ -36,34 +37,49 @@ fn calculate(
cx: &Context<'_, '_>,
map: &mut HashMap<Unit, Lto>,
unit: &Unit,
require_bitcode: bool,
lto_for_deps: Lto,
) -> CargoResult<()> {
let (lto, require_bitcode_for_deps) = if unit.target.for_host() {
let (lto, lto_for_deps) = if unit.target.for_host() {
// Disable LTO for host builds since we only really want to perform LTO
// for the final binary, and LTO on plugins/build scripts/proc macros is
// largely not desired.
(Lto::None, false)
} else if unit.target.can_lto() {
// Otherwise if this target can perform LTO then we're going to read the
// LTO value out of the profile. Note that we ignore `require_bitcode`
(Lto::None, Lto::None)
} else if unit.target.is_linkable() {
// A "linkable" target is one that produces and rlib or dylib in this
// case. In this scenario we cannot pass `-Clto` to the compiler because
// that is an invalid request, this is simply a dependency. What we do,
// however, is respect the request for whatever dependencies need to
// have.
//
// Here if no LTO is requested then we keep it turned off. Otherwise LTO
// is requested in some form, which means ideally we need just what's
// requested, nothing else. It's possible, though, to have libraries
// which are both a cdylib and and rlib, for example, which means that
// object files are getting sent to the linker. That means that we need
// to fully embed bitcode rather than simply generating just bitcode.
let has_non_linkable_lib = match unit.target.kind() {
TargetKind::Lib(kinds) => kinds.iter().any(|k| !k.is_linkable()),
_ => true,
};
match lto_for_deps {
Lto::None => (Lto::None, Lto::None),
_ if has_non_linkable_lib => (Lto::EmbedBitcode, Lto::EmbedBitcode),
other => (other, other),
}
} else {
// Otherwise this target can perform LTO and we're going to read the
// LTO value out of the profile. Note that we ignore `lto_for_deps`
// here because if a unit depends on another unit than can LTO this
// isn't a rustc-level dependency but rather a Cargo-level dependency.
// For example this is an integration test depending on a binary.
match unit.profile.lto {
profiles::Lto::Named(s) => match s.as_str() {
"n" | "no" | "off" => (Lto::Run(Some(s)), false),
_ => (Lto::Run(Some(s)), true),
"n" | "no" | "off" => (Lto::Run(Some(s)), Lto::None),
_ => (Lto::Run(Some(s)), Lto::OnlyBitcode),
},
profiles::Lto::Bool(true) => (Lto::Run(None), true),
profiles::Lto::Bool(false) => (Lto::None, false),
profiles::Lto::Bool(true) => (Lto::Run(None), Lto::OnlyBitcode),
profiles::Lto::Bool(false) => (Lto::None, Lto::None),
}
} else if require_bitcode {
// Otherwise we're a dependency of something, an rlib. This means that
// if our parent required bitcode of some kind then we need to generate
// bitcode.
(Lto::OnlyBitcode, true)
} else {
(Lto::None, false)
};

match map.entry(unit.clone()) {
Expand Down Expand Up @@ -93,14 +109,12 @@ fn calculate(
// either only-objects or only-bitcode we have to embed both in
// rlibs (used for different compilations), so we switch to
// embedding bitcode.
(Lto::OnlyBitcode, Lto::None)
| (Lto::OnlyBitcode, Lto::EmbedBitcode)
| (Lto::None, Lto::OnlyBitcode)
| (Lto::None, Lto::EmbedBitcode) => Lto::EmbedBitcode,
(Lto::OnlyBitcode, Lto::None) | (Lto::None, Lto::OnlyBitcode) => Lto::EmbedBitcode,

// Currently this variant is never calculated above, so no need
// to handle this case.
(Lto::EmbedBitcode, _) => unreachable!(),
// Once a target has requested bitcode embedding that's the
// maximal amount of work that can be done, so we just keep
// doing that work.
(Lto::EmbedBitcode, _) | (_, Lto::EmbedBitcode) => Lto::EmbedBitcode,
};
// No need to recurse if we calculated the same value as before.
if result == *v.get() {
Expand All @@ -111,7 +125,7 @@ fn calculate(
}

for dep in cx.unit_deps(unit) {
calculate(cx, map, &dep.unit, require_bitcode_for_deps)?;
calculate(cx, map, &dep.unit, lto_for_deps)?;
}
Ok(())
}
11 changes: 0 additions & 11 deletions src/cargo/core/manifest.rs
Original file line number Diff line number Diff line change
Expand Up @@ -842,17 +842,6 @@ impl Target {
self.kind().rustc_crate_types()
}

pub fn can_lto(&self) -> bool {
match self.kind() {
TargetKind::Lib(v) => {
!v.contains(&CrateType::Rlib)
&& !v.contains(&CrateType::Dylib)
&& !v.contains(&CrateType::Lib)
}
_ => true,
}
}

pub fn set_tested(&mut self, tested: bool) -> &mut Target {
Arc::make_mut(&mut self.inner).tested = tested;
self
Expand Down
75 changes: 75 additions & 0 deletions tests/testsuite/lto.rs
Original file line number Diff line number Diff line change
Expand Up @@ -336,3 +336,78 @@ fn test_all_and_bench() {
.with_stderr_contains("[RUNNING] `rustc[..]--crate-name foo[..]-C lto[..]")
.run();
}

#[cargo_test]
fn cdylib_and_rlib() {
if !cargo_test_support::is_nightly() {
return;
}

Package::new("registry", "0.0.1")
.file("src/lib.rs", "pub fn foo() {}")
.publish();
Package::new("registry-shared", "0.0.1")
.file("src/lib.rs", "pub fn foo() {}")
.publish();

let p = project()
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.0.0"

[workspace]

[dependencies]
bar = { path = 'bar' }
registry-shared = "*"

[profile.release]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The release here isn't necessary. You could use profile.dev and omit the --release further down

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah that's ok, these are just internal tests.

lto = true
"#,
)
.file(
"src/main.rs",
"
fn main() {
bar::foo();
registry_shared::foo();
}
",
)
.file(
"bar/Cargo.toml",
r#"
[package]
name = "bar"
version = "0.0.0"

[dependencies]
registry = "*"
registry-shared = "*"

[lib]
crate-type = ['cdylib', 'rlib']
"#,
)
.file(
"bar/src/lib.rs",
"
pub fn foo() {
registry::foo();
registry_shared::foo();
}
",
)
.file("tests/a.rs", "")
.file("bar/tests/b.rs", "")
.build();
p.cargo("build --release -v").run();
p.cargo("test --release -v").run();
p.cargo("build --release -v --manifest-path bar/Cargo.toml")
.run();
p.cargo("test --release -v --manifest-path bar/Cargo.toml")
.run();
}