Reexport likely/unlikely in std::hint

[x17jiri]

Since likely/unlikely should be working now, we could reexport them in std::hint. I'm not sure if this is already approved or if it requires approval

Tracking issue: #26179

[rustbot]

r? @workingjubilee

rustbot has assigned @workingjubilee.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

[ChrisDenton]

This would need lang and libs-api to look over. I'd note that the discussion in the tracking issue seems to be saying that this is the wrong API. In particular a #[cold] attribute or maybe a cold_path() function would be a better way forward.

[Noratrieb]

Yes, I agree with #26179 (comment) that likely/unlikely is the wrong API (the current implementation makes it look very silly, a roundabout way to just use cold_path) and I think we should move forward with cold_path, it's extremely simple and more reliable than likely/unlikely (and maybe #[cold] for match arms).

I think the next step would be to create an ACP for cold_path: https://std-dev-guide.rust-lang.org/development/feature-lifecycle.html

[x17jiri]

cold_path() will need an update in the codegen to make it more useful. If we decide it's the way to go, I can work on ït.

Basically the current implementation gathers information about which code paths are cold, but this information is only used in select with 2 options. This was all I needed to fix likely and unlikely and I didn't want to make the PR bigger than needed.

However common patterns in Rust generate select with more than 2 options. For example this code:

if let Some(x) = t { ... }

May generate something equivalent to:

match t.discriminator {
1 => true branch,
0 => false branch, 
_ => unreachable
}

[workingjubilee]

"the compiler currently doesn't support the better option" sounds fixable.

[x17jiri]

@workingjubilee I'm all for improving cold_path(). I'm the guy who invented it. I even said I can work on it :-)

But likely and unlikely are more readable in some situations. For example if likely(cond) { ... } vs if cond { ... } else { cold_path() }. You can also use hem for parts of conditions. For example if a && likely(b) { ... }

And since there is RFC I thought they may already be approved

[tgross35]

If we had hint::cold_path() then we wouldn't need #[cold] on if/match (#120193) right? But if we instead had likely/unlikely, we would still need something different for match? Keeping things consolidated to a single feature seems like a nice advantage to me (we do already have #[cold] but applying attributes to match arms is pretty novel).

In any case you should file an ACP at https://github.com/rust-lang/libs-team/issues (it's just an issue template) for adding something new in hint.

And since there is RFC I thought they may already be approved

Given it was accepted about a decade ago, there is a good chance it would have to be revisited anyway :)

[x17jiri]

@tgross35 I'd like to have both likely/unlikely and cold_path, because cold_path can sometimes be awkward.

For example, I think:

if likely(cond) { ... }

is more readable than:

if cond { ... } else { cold_path() }

I'll look into the ACP and try to create one for all of these functions.

[tgross35]

I agree it's not the most convenient when you have one branch that you want to prioritize rather than deprioritizing all others, for either cold_path() or #[cold]. In theory could we also have hint::hot_path()? Not saying we necessarily want both, but this would also work better than likely for match arms.

[workingjubilee]

it might be useful to review https://blog.aaronballman.com/2020/08/dont-use-the-likely-or-unlikely-attributes/ which raises some relevant concerns.

[x17jiri]

@tgross35 We could implement hot_path() the same way as cold_path(). My concern is this:

The current implementation leaves the cold_path instruction in MIR until all MIR passes finish. Then in the codegen, it is detected and removed. Could the presence of this simple no-op prevent some MIR optimizations? I don't really know the answer to that, but if yes, it would be bigger deal for hot path than it is for cold path.

[x17jiri]

@workingjubilee Most of the points in the article seem to be about the specification for [[likely]] and [[unlikely]] not being clear enough. We can specify them in terms of cold_path and things become clear and predictable.

For example when you write:

    if likely(unlikely(x)) {
        true_branch
    } else {
        false_branch
    }

It will get expanded to:

    if x {
        cold_path();
        true_branch
    } else {
        cold_path();
        false_branch
    }

And since both paths are cold, they have the same weight and so cold_path is ignored

[hanna-kruppe]

Is there any objection to having hint::cold_path(), at least as basic building block? Even if other ways of expressing branch weights may be more convenient to use, they seem harder to design and get right. So how about introducing the basic primitive that users can’t implement without compiler support, and worry about sugar later? For example, likely/unlikely annotations on if and match could be prototyped as third party proc macros if cold_path() is available. No promises that this will work perfectly - but if there’s problems with it, that can inform the discussion about directly supporting it in rustc.

[x17jiri]

rust-lang/libs-team#510

@hanna-kruppe No objections to cold_path(). I just needed to find the time and write the proposal 😃

[Amanieu]

One concern I have with the current implementation is that it doesn't support nesting properly: it just splits the function into a normal half and a cold half.

Consider this example:

if A {
} else {
    cold_path();
	if B {
    } else {
    	cold_path();
    }
}

At the moment rustc will correctly mark condition A as likely, but will not do so for B because both branches are already within a "cold path".

[x17jiri]

@Amanieu I need to verify, but this situation should work ok.

The code detecting cold blocks goes from bottom to top.

Edit: I just tested the example and branch weights are emited for both branches

[workingjubilee]

Is there any objection to having hint::cold_path(), at least as basic building block? Even if other ways of expressing branch weights may be more convenient to use, they seem harder to design and get right.

No objections from me, for sure.

It's very hard to use this particular category of optimization hint correctly, so I am strongly in favor of simply, on nightly, directly exposing all the details while we discuss if it can be used correctly at all. If it seems that unlikely and likely are the correct design, then we don't need cold_path, but that seems less likely to me.

[workingjubilee]

r? @Amanieu

[Amanieu]

Suggested change

	/// Hints to the compiler that branch condition is likely to be true.
	/// Hints to the compiler that a branch condition is likely to be true.

[x17jiri]

fixed

[Amanieu]

Can this be expanded a bit? What happens if you use it outside (presumably, nothing)? Can this be used in a && or || expression?

[Amanieu]

Also it would be good to point people to cold_path (for which we just approved the ACP) for general match and if let.

[x17jiri]

Should I also export cold_path() in this PR, or create a new PR for that?

[Amanieu]

You can do it in this PR.

[x17jiri]

Added

[x17jiri]

I also added a test for cold_path(), but not with idiomatic Rust such as if let ... because this will only work after #133852

[Amanieu]

@rustbot author

[Amanieu]

Stray newline.

[x17jiri]

removed

[Sky9x]

As with all¹ of the functions in the std::hint module, the compiler/processor is allowed to ignore it (ie. it is allowed to do nothing). Perhaps this language should be changed to clarify this.

Footnotes

1. Except unreachable_unchecked ↩

[x17jiri]

Reworded

[Sky9x]

I don't believe this attribute is appropriate for public functions.

Suggested change

#[rustc_nounwind]

[x17jiri]

Attribute removed

[Sky9x]

I don't believe this attribute is appropriate for public functions.

Suggested change

#[rustc_nounwind]

[x17jiri]

Attribute removed

[Sky9x]

I don't believe this attribute is appropriate for public functions.

Suggested change

#[rustc_nounwind]

[x17jiri]

Attribute removed

[Amanieu]

@bors r+

[bors]

📌 Commit cb2efaf has been approved by Amanieu

It is now in the queue for this repository.