Skip to content

Add -C hint-mostly-unused option #829

Open
@joshtriplett

Description

Proposal

Some libraries are extremely large, and users use only a small fraction of their surface area. Crate features aren't ideal for just reducing the size of a very large library; that would require the crate maintainer to predict and provide semantic subsets that people will use, and commit to maintaining those subsets indefinitely as a stable API. That also doesn't scale well to crates with thousands of functions or structures; having thousands of features is a problem for maintenance, and for usability (carefully enabling the needed subset).

Introduce an option, -C hint-mostly-unused, which hints to rustc that most of a crate's API surface area may go unused.

Currently, this will make a crate provide all its code as MIR, to be compiled only when referenced. This functionality already exists as -Zcross-crate-inline-threshold=always. I'm proposing to provide a stable hint option to access the same underlying functionality.

I've tested this on some crates with very large dependencies. On one project, adding this option to just the three largest dependencies reduced total compilation time from 10m30s to 6m12s.

(No attachment to the specific option name, happy to change it.)

I also intend to propose a corresponding option in Cargo, which can be enabled on a per-dependency basis. (And, later, we can add a way for large crates to hint that they should have this option enabled by default unless overridden.)

Inspired by @saethlin's MIR-only rlibs work at rust-lang/rust#119017 .

Notes

  • Need to make sure this does not override #[inline(never)].
  • The new option will need documentation.
  • This shouldn't be applied to the entire crate graph; it should be applied selectively. The documentation should provide guidance on when it may provide benefit.

Process

The main points of the Major Change Process are as follows:

  • File an issue describing the proposal.
  • A compiler team member or contributor who is knowledgeable in the area can second by writing @rustbot second.
    • Finding a "second" suffices for internal changes. If however, you are proposing a new public-facing feature, such as a -C flag, then full team check-off is required.
    • Compiler team members can initiate a check-off via @rfcbot fcp merge on either the MCP or the PR.
  • Once an MCP is seconded, the Final Comment Period begins. If no objections are raised after 10 days, the MCP is considered approved.

You can read more about Major Change Proposals on forge.

Comments

This issue is not meant to be used for technical discussion. There is a Zulip stream for that. Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.

Metadata

Assignees

No one assigned

    Labels

    T-compilerAdd this label so rfcbot knows to poll the compiler teammajor-changeA proposal to make a major change to rustc

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions