Skip to content

Code bloat from monomorphization of methods applied to arrays #77767

Open
@glandium

Description

@glandium
Contributor

The following talks about Debug::fmt, but is likely true of a lot more methods applied to arrays.
Take the following code:

fn main() {
    let a = [1, 2, 3];
    let b = [1, 2, 3, 4];
    let c = [1, 2, 3, 4, 5];
    let d = [1, 2, 3, 4, 5, 6];
    println!("{:?}", a);
    println!("{:?}", b);
    println!("{:?}", c);
    println!("{:?}", d);
}

Compiled with --release, you end up with 4 different functions for core::array::<impl core::fmt::Debug for [T; N]>::fmt (BTW, shouldn't they each have their N replaced by the actual number?). To add insult to injury, each of these have their loops unrolled, so the longer the array, the larger the function, up to 59 (!).
Almost ironically, building with -C opt-level=1 generates 4 functions that create a slice and a separate, common, fmt function for it.
This is one of these cases where you'd probably want a #[inline(never)] at the call site in core::array::<impl core::fmt::Debug for [T; N]>::fmt if that were possible.

Activity

added
A-fmtArea: `core::fmt`
C-enhancementCategory: An issue proposing an enhancement or a PR with one.
I-heavyIssue: Problems and improvements with respect to binary size of generated code.
on Oct 9, 2020
cuviper

cuviper commented on Oct 9, 2020

@cuviper
Member

This is one of these cases where you'd probably want a #[inline(never)] at the call site in core::array::<impl core::fmt::Debug for [T; N]>::fmt if that were possible.

We could insert a shim #[inline(never)] function to call the slice Debug::fmt.

For other traits, I'd worry about hurting bounds-checking and vectorization if we add artificial barriers.

scottmcm

scottmcm commented on Oct 11, 2020

@scottmcm
Member

Given that these things are already implemented by calling the slice versions, I don't know that there's actually anything array-specific here. This is just the inliner doing what it's told to do. The same thing will plausibly happen with impl AsRef<Path> methods with outlined bodies too in -O3.

Given that -O1 is doing the right thing here, I suspect -Os is too, which is the particularly-important part IMHO.

Even for debug it's not obvious to me that inline(never) is desirable here. I could easily imagine someone expecting monomorphization of something like <[u32; 4]>::debug because there's no other way to stringify such an array in std.

Note that neither the array nor slice implementations of Debug are currently even marked #[inline]:

#[stable(feature = "rust1", since = "1.0.0")]
impl<T: fmt::Debug, const N: usize> fmt::Debug for [T; N] {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Debug::fmt(&&self[..], f)
}
}

#[stable(feature = "rust1", since = "1.0.0")]
impl<T: Debug> Debug for [T] {
fn fmt(&self, f: &mut Formatter<'_>) -> Result {
f.debug_list().entries(self.iter()).finish()
}
}

so this is all LLVM's inlining heuristic deciding that this is a good bet with no extra encouragement.

Were you seeing a regression here? I suppose that this could have changed last summer when we started using const generics for them, or if one of the LLVM upgrades changed the inlining heuristics...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-arrayArea: `[T; N]`A-fmtArea: `core::fmt`C-enhancementCategory: An issue proposing an enhancement or a PR with one.I-heavyIssue: Problems and improvements with respect to binary size of generated code.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @cuviper@glandium@jonas-schievink@scottmcm@workingjubilee

        Issue actions

          Code bloat from monomorphization of methods applied to arrays · Issue #77767 · rust-lang/rust